本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
ListServers
列出与您的 Amazon 账户关联的文件传输协议服务器。
请求语法
{
"MaxResults": number,
"NextToken": "string"
}请求参数
有关所有操作的通用参数的信息，请参阅通用参数。
请求接受采用 JSON 格式的以下数据。
- MaxResults
-
指定作为对
ListServers请求的响应而返回的用户数。类型：整数
有效范围：最小值为 1。最大值为 1000。
必需：否
- NextToken
-
当您可以从
ListServers调用中获得其他结果时，将在输出中返回一个NextToken参数。然后，您可以在后续命令中传递NextToken参数以继续列出其他工作流程。类型：字符串
长度限制：最小长度为 1。长度上限为 6144。
必需：否
响应语法
{
"NextToken": "string",
"Servers": [
{
"Arn": "string",
"Domain": "string",
"EndpointType": "string",
"IdentityProviderType": "string",
"LoggingRole": "string",
"ServerId": "string",
"State": "string",
"UserCount": number
}
]
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- NextToken
-
当您可以从
ListServers调用中获得其他结果时，将在输出中返回一个NextToken参数。在以下命令中，您可以传入NextToken参数以继续列出其他服务器。类型：字符串
长度限制：最小长度为 1。长度上限为 6144。
- Servers
-
已列出一系列服务器。
类型：ListedServer 对象数组
错误
有关所有操作返回的常见错误的信息，请参阅常见错误。
- InternalServiceError
-
当 Amazon Transfer Family服务中发生错误时，会引发此异常。
HTTP 状态代码：500
- InvalidNextTokenException
-
传递的
NextToken参数无效。HTTP 状态代码：400
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
- ServiceUnavailableException
-
请求失败，因为 AmazonTransfer Family 服务不可用。
HTTP 状态代码：500
示例
示例
以下示例列出了您的Amazon Web Services 账户中存在的服务器。
请注意，示例 NextToken 值不是真实的：它们旨在指示如何使用参数。
示例请求
{
"MaxResults": 1,
"NextToken": "token-from-previous-API-call"
}示例响应
{
"NextToken": "another-token-to-continue-listing",
"Servers": [
{
"Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
"Domain": "S3",
"IdentityProviderType": "SERVICE_MANAGED",
"EndpointType": "PUBLIC",
"LoggingRole": "arn:aws:iam::111112222222:role/my-role",
"ServerId": "s-01234567890abcdef",
"State": "ONLINE",
"UserCount": 3
}
]
}另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息，请参阅以下内容：