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

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

ListServers

列出启用文件传输协议的服务器，这些服务器与Amazonaccount.

请求语法

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

请求参数

有关所有操作通用的参数的信息，请参阅常见参数.

请求接受采用 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。

服务器

列出的服务器阵列。

类型: 数组ListedServerobjects

Errors

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

InternalServiceError

在出现错误时，会引发此异常。AmazonTTransfer Family

HTTP 状态代码：500

InvalidNextTokenException

这些区域有：NextToken参数是无效的。

HTTP 状态代码：400

InvalidRequestException

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

HTTP 状态代码：400

ServiceUnavailableException

请求失败，因为Amazon酒店不提供 Transfer Family 服务。

HTTP 状态代码：500

Examples

Example

以下示例列出了Amazonaccount.

示例请求


{
   "MaxResults": 100,
   "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ=="
}

Example

此示例说明了 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"
            }
         ]
      }
   ]
}

另请参阅

有关在特定语言的特定语言的服务器中使用此 API 的更多信息。Amazon开发工具包，请参阅以下：