DescribeAgreement - Amazon Transfer Family
请求语法请求参数响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

DescribeAgreement

描述由AgreementId标识的协议。

请求语法

{
   "AgreementId": "string",
   "ServerId": "string"
}

请求参数

有关所有操作的通用参数的信息，请参阅通用参数。

请求接受采用 JSON 格式的以下数据。

AgreementId

协议的唯一标识符。创建协议时会返回此标识符。

类型：字符串

长度限制：固定长度为 19。

模式：a-([0-9a-f]{17})

必需：是

ServerId

与协议关联的服务器标识符。

类型：字符串

长度限制：固定长度为 19。

模式：s-([0-9a-f]{17})

必需：是

响应语法

{
   "Agreement": { 
      "AccessRole": "string",
      "AgreementId": "string",
      "Arn": "string",
      "BaseDirectory": "string",
      "Description": "string",
      "LocalProfileId": "string",
      "PartnerProfileId": "string",
      "ServerId": "string",
      "Status": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

Agreement

指定协议的详细信息，以DescribedAgreement对象形式返回。

类型：DescribedAgreement 对象

错误

有关所有操作的常见错误信息，请参阅常见错误。

InternalServiceError

当 Amazon Transfer Family 服务中发生错误时，会引发此异常。

HTTP 状态代码：500

InvalidRequestException

当客户端提交格式错误的请求时，会引发此异常。

HTTP 状态代码：400

ResourceNotFoundException

当 Transfer Family 服务找不到资源时，就会 Amazon引发此异常。

HTTP 状态代码：400

ServiceUnavailableException

请求失败，因为 Trans Amazon fer Family 服务不可用。

HTTP 状态代码：500

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息，请参阅以下内容：