选择您的 Cookie 首选项

我们使用必要 Cookie 和类似工具提供我们的网站和服务。我们使用性能 Cookie 收集匿名统计数据,以便我们可以了解客户如何使用我们的网站并进行改进。必要 Cookie 无法停用,但您可以单击“自定义”或“拒绝”来拒绝性能 Cookie。

如果您同意,AWS 和经批准的第三方还将使用 Cookie 提供有用的网站功能、记住您的首选项并显示相关内容,包括相关广告。要接受或拒绝所有非必要 Cookie,请单击“接受”或“拒绝”。要做出更详细的选择,请单击“自定义”。

ListServers - AWS Transfer Family
此页面尚未翻译为您的语言。 请求翻译

ListServers

Lists the file transfer protocol-enabled servers that are associated with your AWS account.

Request Syntax

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

Specifies the number of servers to return as a response to the ListServers query.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

Required: No

Response Syntax

{ "NextToken": "string", "Servers": [ { "Arn": "string", "Domain": "string", "EndpointType": "string", "IdentityProviderType": "string", "LoggingRole": "string", "ServerId": "string", "State": "string", "UserCount": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

Servers

An array of servers that were listed.

Type: Array of ListedServer objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer Family service.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken parameter that was passed is invalid.

HTTP Status Code: 400

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

Examples

Example

The following example lists the servers that exist in your AWS account.

Note that the example NextToken values are not real: they are meant to indicate how to use the parameter.

Sample Request

{ "MaxResults": 1, "NextToken": "token-from-previous-API-call" }

Sample Response

{ "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 } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隐私网站条款Cookie 首选项
© 2025, Amazon Web Services, Inc. 或其附属公司。保留所有权利。