ListUsers - AWS Transfer Family

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 format JSON.

MaxResults

Menentukan jumlah pengguna untuk kembali sebagai respon terhadap ListUsers permintaan.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 1000.

Wajib: Tidak

NextToken

Jika ada hasil tambahan dari ListUsers panggilan, NextToken parameter dikembalikan dalam output. Anda kemudian dapat meneruskan NextToken ke ListUsers perintah berikutnya, untuk melanjutkan daftar pengguna tambahan.

Jenis: 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.

Jenis: 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.

Layanan mengembalikan data berikut dalam format JSON.

NextToken

Ketika Anda bisa mendapatkan hasil tambahan dari ListUsers panggilan, NextToken parameter dikembalikan dalam output. Anda kemudian dapat meneruskan perintah berikutnya ke NextToken parameter untuk melanjutkan daftar pengguna tambahan.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

ServerId

Pengidentifikasi unik yang ditetapkan sistem untuk server tempat pengguna ditugaskan.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: s-([0-9a-f]{17})

Users

Mengembalikan pengguna Transfer Family dan propertinya untuk ServerId nilai 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.

Kode Status HTTP: 500

InvalidNextTokenException

NextTokenParameter yang dilewatkan tidak valid.

Kode Status HTTP: 400

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceNotFoundException

Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

Contoh

Contoh

Panggilan ListUsers API menampilkan daftar pengguna yang terkait dengan server yang Anda tentukan.

Permintaan Sampel

{ "MaxResults": 100, "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==", "ServerId": "s-01234567890abcdef" }

Contoh

Ini adalah contoh respons untuk panggilan API 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 API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: