GetCluster - Amazon DocumentDB

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á.

GetCluster

Retorna informações sobre um cluster elástico específico.

Sintaxe da Solicitação

GET /cluster/clusterArn HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

clusterArn

O identificador ARN do cluster elástico.

Obrigatório: sim

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da resposta

HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } }

Elementos de Resposta

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

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

cluster

Retorna informações sobre um cluster elástico específico.

Tipo: objeto Cluster

Erros

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

AccessDeniedException

Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.

Código de Status HTTP: 403

InternalServerException

Ocorreu um erro interno do servidor.

Código de Status HTTP: 500

ResourceNotFoundException

O recurso especificado não foi localizado.

Código de Status HTTP: 404

ThrottlingException

ThrottlingException será lançada quando a solicitação for negada devido à limitação da solicitação.

Código de Status HTTP: 429

ValidationException

Uma estrutura que define uma exceção de validação.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: