本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
ListServers
列出与您的Amazon账户关联的启用了文件传输协议的服务器。
请求语法
{
"MaxResults": number,
"NextToken": "string"
}请求参数
有关所有操作的常用参数的信息，请参阅Common Parameters (常用参数)。
请求接受采用 JSON 格式的以下数据。
- MaxResults
-
指定作为
ListServers查询响应返回的服务器数量。类型：整数
有效范围：最小值为 1。最大值为 1 000。
必需：否
- 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
-
当 Transfer Family 服务中发生错误时，会Amazon引发此异常。
HTTP 状态代码：500
- InvalidNextTokenException
-
传递的
NextToken参数无效。HTTP 状态代码：400
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
- ServiceUnavailableException
-
由于 Transfer FamAmazon ily 服务不可用，请求失败。
HTTP 状态代码：500
示例
示例
以下示例列出了您的中存在的服务器Amazon Web Services 账户。
示例请求
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ=="
}示例
此示例说明了的一种用法 ListServers。
示例响应
{
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"Servers": [
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef",
"LoggingRole": "CloudWatchLoggingRole",
"ServerId": "s-01234567890abcdef",
"State": "ONLINE",
"Tags": [
{
"Key": "Name",
"Value": "MyServer"
}
]
}
]
}另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：