Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
ListUsers
Daftar pengguna untuk server berkemampuan protokol transfer file yang Anda tentukan dengan meneruskan parameter. ServerId
Sintaksis Permintaan
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "string"
}Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
Permintaan menerima data berikut dalam JSON format.
- MaxResults
-
Menentukan jumlah pengguna untuk kembali sebagai respon terhadap
ListUserspermintaan.Jenis: Integer
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 1000.
Wajib: Tidak
- NextToken
-
Jika ada hasil tambahan dari
ListUserspanggilan,NextTokenparameter dikembalikan dalam output. Anda kemudian dapat meneruskanNextTokenkeListUsersperintah berikutnya, untuk melanjutkan daftar pengguna tambahan.Tipe: String
Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.
Wajib: Tidak
- ServerId
-
Pengidentifikasi unik yang ditetapkan sistem untuk server yang memiliki pengguna yang ditugaskan untuk itu.
Tipe: String
Kendala Panjang: Panjang tetap 19.
Pola:
s-([0-9a-f]{17})Diperlukan: Ya
Sintaksis Respons
{
"NextToken": "string",
"ServerId": "string",
"Users": [
{
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryType": "string",
"Role": "string",
"SshPublicKeyCount": number,
"UserName": "string"
}
]
}Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Data berikut dikembalikan dalam JSON format oleh layanan.
- NextToken
-
Ketika Anda bisa mendapatkan hasil tambahan dari
ListUserspanggilan,NextTokenparameter dikembalikan dalam output. Anda kemudian dapat meneruskan perintah berikutnya keNextTokenparameter untuk melanjutkan daftar pengguna tambahan.Tipe: String
Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.
- ServerId
-
Pengidentifikasi unik yang ditetapkan sistem untuk server tempat pengguna ditugaskan.
Tipe: String
Kendala Panjang: Panjang tetap 19.
Pola:
s-([0-9a-f]{17}) - Users
-
Mengembalikan pengguna Transfer Family dan propertinya untuk
ServerIdnilai yang Anda tentukan.Tipe: Array objek ListedUser
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- InternalServiceError
-
Pengecualian ini dilemparkan ketika kesalahan terjadi dalam AWS Transfer Family layanan.
HTTPKode Status: 500
- InvalidNextTokenException
-
NextTokenParameter yang dilewatkan tidak valid.HTTPKode Status: 400
- InvalidRequestException
-
Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.
HTTPKode Status: 400
- ResourceNotFoundException
-
Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.
HTTPKode Status: 400
- ServiceUnavailableException
-
Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.
HTTPKode Status: 500
Contoh
Contoh
ListUsersAPIPanggilan mengembalikan daftar pengguna yang terkait dengan server yang Anda tentukan.
Permintaan Sampel
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef"
}
Contoh
Ini adalah contoh respons untuk API panggilan ini.
Contoh Respons
{
"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"
}
]
}Lihat Juga
Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
