本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
ListUsers
列出您透過傳遞 ServerId 參數所指定的檔案傳輸通訊協定啟用伺服器的使用者。
請求語法
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "string"
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受下列JSON格式的資料。
- MaxResults
-
指定要傳回作為
ListUsers請求回應的使用者數目。類型：整數
有效範圍：最小值為 1。最大值為 1000。
必要：否
- NextToken
-
如果
ListUsers呼叫有其他結果，輸出中會傳回NextToken參數。然後，您可以將 傳遞NextToken至後續ListUsers命令，以繼續列出其他使用者。類型：字串
長度限制：長度下限為 1。長度上限為 6144。
必要：否
- ServerId
-
系統指派的唯一識別碼，適用於已指派使用者給伺服器的伺服器。
類型：字串
長度限制條件：固定長度為 19。
模式：
s-([0-9a-f]{17})必要：是
回應語法
{
"NextToken": "string",
"ServerId": "string",
"Users": [
{
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryType": "string",
"Role": "string",
"SshPublicKeyCount": number,
"UserName": "string"
}
]
}回應元素
如果動作成功，服務會傳回 HTTP 200 個回應。
服務會以 JSON 格式傳回下列資料。
- NextToken
-
當您可以從
ListUsers呼叫取得其他結果時，輸出中會傳回NextToken參數。然後，您可以在後續命令中傳遞至NextToken參數，以繼續列出其他使用者。類型：字串
長度限制：長度下限為 1。長度上限為 6144。
- ServerId
-
指派給使用者之伺服器的系統指派唯一識別碼。
類型：字串
長度限制條件：固定長度為 19。
模式：
s-([0-9a-f]{17}) - Users
-
傳回指定
ServerId值的 Transfer Family 使用者及其屬性。類型：ListedUser 物件陣列
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InternalServiceError
-
當 AWS Transfer Family 服務發生錯誤時，就會擲回此例外狀況。
HTTP 狀態碼：500
- InvalidNextTokenException
-
傳遞的
NextToken參數無效。HTTP 狀態碼：400
- InvalidRequestException
-
當用戶端提交格式不正確的請求時，就會擲回此例外狀況。
HTTP 狀態碼：400
- ResourceNotFoundException
-
當 AWS Transfer Family 服務找不到資源時，就會擲回此例外狀況。
HTTP 狀態碼：400
- ServiceUnavailableException
-
請求失敗，因為 AWS Transfer Family 服務無法使用。
HTTP 狀態碼：500
範例
範例
ListUsers API 呼叫會傳回與您指定的伺服器相關聯的使用者清單。
請求範例
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef"
}
範例
這是此API呼叫的範例回應。
回應範例
{
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef",
"Users": [
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
"HomeDirectory": "/tests/home/charlie",
"SshPublicKeyCount": 1,
"Role": "arn:aws:iam::176354371281:role/transfer-role1",
"Tags": [
{
"Key": "Name",
"Value": "user1"
}
],
"UserName": "my_user"
}
]
}另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：
