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

MaxResults

Menentukan jumlah server untuk kembali sebagai respon terhadap ListServers query.

Jenis: Integer

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

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

Tipe: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

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

Data berikut dikembalikan dalam JSON format oleh layanan.

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.

Tipe: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

Servers

Array server yang terdaftar.

Tipe: Array objek ListedServer

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

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

HTTPKode Status: 500

Contoh

Contoh

Contoh berikut mencantumkan server yang ada di Anda Akun 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 ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini:

• AWS Antarmuka Baris Perintah

• AWS SDKuntuk. NET

• AWS SDKuntuk C ++

• AWS SDKuntuk Go

• AWS SDKuntuk Java V2

• AWS SDKuntuk JavaScript V3

• AWS SDKuntuk PHP V3

• AWS SDKuntuk Python

• AWS SDKuntuk Ruby V3