DescribeClusters - Amazon MemoryDB

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DescribeClusters

Recupera informações sobre todos os clusters provisionados se nenhum identificador de cluster for especificado, ou sobre um cluster específico, se um identificador de cluster for fornecido.

Sintaxe da Solicitação

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

Parâmetros da solicitação

Para obter informações sobre os parâmetros comuns a todas as ações, consulte Parâmetros Comuns.

A solicitação aceita os seguintes dados no JSON formato.

ClusterName

O nome do cluster

Tipo: string

Obrigatório: Não

MaxResults

O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o MaxResults valor especificado, um token será incluído na resposta para que os resultados restantes possam ser recuperados.

Tipo: número inteiro

Obrigatório: não

NextToken

Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se nextToken for retornado, há mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.

Tipo: string

Obrigatório: Não

ShowShardDetails

Um sinalizador opcional que pode ser incluído na solicitação para recuperar informações sobre os fragmentos individuais.

Tipo: booliano

Obrigatório: não

Sintaxe da Resposta

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

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.

Os dados a seguir são retornados em JSON formato pelo serviço.

Clusters

Uma lista de clusters

Tipo: matriz de objetos Cluster

NextToken

Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se nextToken for retornado, há mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.

Tipo: string

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

ClusterNotFoundFault

HTTPCódigo de status: 400

InvalidParameterCombinationException

HTTPCódigo de status: 400

InvalidParameterValueException

HTTPCódigo de status: 400

ServiceLinkedRoleNotFoundFault

HTTPCódigo de status: 400

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: