本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListAgreements
返回由您提供的 ServerId
标识的服务器协议列表。如果要将结果限制为某个数值,请为 MaxResults
参数提供一个值。如果您之前运行过该命令并收到了的NextToken
值,则可以提供该值,以继续从上次中断的地方列出配置文件。
请求语法
{
"MaxResults": number
,
"NextToken": "string
",
"ServerId": "string
"
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
请求接受采用 JSON 格式的以下数据。
- MaxResults
-
要返回的最大结果数量。
类型:整数
有效范围:最小值为 1。最大值为 1000。
必需:否
- 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
-
当 Amazon Transfer Family 服务中发生错误时,会引发此异常。
HTTP 状态代码:500
- InvalidNextTokenException
-
传递的
NextToken
参数无效。HTTP 状态代码:400
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
- ResourceNotFoundException
-
当 Transfer Family 服务找不到资源时,就会 Amazon引发此异常。
HTTP 状态代码:400
- ServiceUnavailableException
-
请求失败,因为 Trans Amazon fer Family 服务不可用。
HTTP 状态代码:500
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: