ListAgreements - Amazon Transfer Family
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

ListAgreements

返回由您提供的服务器标识的协议列表。ServerId如果要将结果限制为某个数字,请为MaxResults参数提供一个值。如果您之前运行了命令并收到了的值NextToken,则可以提供该值,以便从上次中断的地方继续发布协议。

请求语法

{ "MaxResults": number, "NextToken": "string", "ServerId": "string" }

请求参数

有关由所有操作共享的参数的详细信息,请参阅Common Parameters (常用参数)。

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

MaxResults

要返回的协议的数量。

类型:整数

有效范围:最小值为 1。最大值为 1 000。

必需:否

NextToken

当您可以从ListAgreements调用中获得更多结果时,输出中会返回一个NextToken参数。然后,您可以将后续命令传递给该NextToken参数,以继续列出其他协议。

类型:字符串

长度限制:最小长度为 1。长度上限为 6144。

必需:否

ServerId

您需要协议列表的服务器的标识符。

类型:字符串

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

模式:^s-([0-9a-f]{17})$

必需:是

响应语法

{ "Agreements": [ { "AgreementId": "string", "Arn": "string", "Description": "string", "LocalProfileId": "string", "PartnerProfileId": "string", "ServerId": "string", "Status": "string" } ], "NextToken": "string" }

响应元素

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

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

Agreements

返回一个数组,其中每个项目都包含协议的详细信息。

类型:ListedAgreement 对象数组

NextToken

返回一个令牌,您可以使用该令牌ListAgreements再次调用并接收其他结果(如果有)。

类型:字符串

长度限制:最小长度为 1。长度上限为 6144。

错误

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

InternalServiceError

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

HTTP 状态代码:500

InvalidNextTokenException

传递的NextToken参数无效。

HTTP 状态代码:400

InvalidRequestException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

由于 Transfer FamAmazon ily 服务不可用,请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: