ListServers - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContoh-contohLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

ListServers

Daftar server berkemampuan protokol transfer file yang terkait dengan akun Anda. AWS

Sintaksis Permintaan

{
   "MaxResults": number,
   "NextToken": "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 server untuk kembali sebagai respon terhadap ListServers query.

Jenis: Integer

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

Diperlukan: Tidak

NextToken

Ketika hasil tambahan diperoleh dari ListServers perintah, NextToken parameter dikembalikan dalam output. Anda kemudian dapat meneruskan NextToken parameter dalam perintah berikutnya untuk melanjutkan daftar server tambahan.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

Diperlukan: Tidak

Sintaksis Respons

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

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 ListServers operasi, NextToken parameter dikembalikan dalam output. Dalam perintah berikut, Anda dapat meneruskan NextToken parameter untuk melanjutkan daftar server tambahan.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

Servers

Sebuah array server yang terdaftar.

Tipe: Array objek ListedServer

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalServiceError

Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS Transfer Family.

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

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

Contoh-contoh

Contoh

Contoh berikut mencantumkan server yang ada di AndaAkun AWS.

Perhatikan bahwa NextToken nilai contoh tidak nyata: mereka dimaksudkan untuk menunjukkan cara menggunakan parameter.

Permintaan Sampel

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

Contoh Respons

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

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: