DescribeClusters - Amazon MemoryDB

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

DescribeClusters

Mengembalikan informasi tentang semua cluster yang disediakan jika tidak ada pengidentifikasi cluster yang ditentukan, atau tentang cluster tertentu jika nama cluster disediakan.

Sintaksis Permintaan

{ "ClusterName": "string", "MaxResults": number, "NextToken": "string", "ShowShardDetails": boolean }

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam JSON format.

ClusterName

Nama cluster

Tipe: String

Wajib: Tidak

MaxResults

Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika ada lebih banyak catatan daripada MaxResults nilai yang ditentukan, token disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

Tipe: Integer

Wajib: Tidak

NextToken

Argumen opsional untuk lulus jika jumlah total catatan melebihi nilai MaxResults. Jika nextToken dikembalikan, ada lebih banyak hasil yang tersedia. Nilai nextToken adalah token pagination unik untuk setiap halaman. Lakukan panggilan lagi menggunakan token yang dikembalikan untuk mengambil halaman berikutnya. Jaga agar semua argumen lainnya tidak berubah.

Tipe: String

Wajib: Tidak

ShowShardDetails

Bendera opsional yang dapat disertakan dalam permintaan untuk mengambil informasi tentang pecahan individu.

Tipe: Boolean

Wajib: Tidak

Sintaksis Respons

{ "Clusters": [ { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "Name": "string", "NodeType": "string", "NumberOfShards": number, "ParameterGroupName": "string", "ParameterGroupStatus": "string", "PendingUpdates": { "ACLs": { "ACLToApply": "string" }, "Resharding": { "SlotMigration": { "ProgressPercentage": number } }, "ServiceUpdates": [ { "ServiceUpdateName": "string", "Status": "string" } ] }, "SecurityGroups": [ { "SecurityGroupId": "string", "Status": "string" } ], "Shards": [ { "Name": "string", "Nodes": [ { "AvailabilityZone": "string", "CreateTime": number, "Endpoint": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } ], "NextToken": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

Clusters

Daftar cluster

Tipe: Array objek Cluster

NextToken

Argumen opsional untuk lulus jika jumlah total catatan melebihi nilai MaxResults. Jika nextToken dikembalikan, ada lebih banyak hasil yang tersedia. Nilai nextToken adalah token pagination unik untuk setiap halaman. Lakukan panggilan lagi menggunakan token yang dikembalikan untuk mengambil halaman berikutnya. Jaga agar semua argumen lainnya tidak berubah.

Tipe: String

Kesalahan

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

ClusterNotFoundFault

HTTPKode Status: 400

InvalidParameterCombinationException

HTTPKode Status: 400

InvalidParameterValueException

HTTPKode Status: 400

ServiceLinkedRoleNotFoundFault

HTTPKode Status: 400

Lihat Juga

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