本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
ListServers
列出與您帳戶相關聯的已啟用檔案傳輸通訊協定的 AWS 伺服器。
請求語法
{
"MaxResults": number,
"NextToken": "string"
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受採用 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
-
當在 AWS Transfer Family 服務中發生錯誤時，拋出此異常。
HTTP 狀態碼：500
- InvalidNextTokenException
-
傳遞的
NextToken參數無效。HTTP 狀態碼：400
- InvalidRequestException
-
當客戶端提交格式錯誤的請求時，拋出此異常。
HTTP 狀態碼：400
- ServiceUnavailableException
-
申請失敗，因為 AWS Transfer Family 服務不可用。
HTTP 狀態碼：500
範例
範例
下列範例會列出您的 AWS 帳戶.
請注意，示例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
}
]
}另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
