GetCluster - Amazon DocumentDB
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GetCluster

Renvoie des informations sur un cluster élastique spécifique.

Syntaxe de la demande

GET /cluster/clusterArn HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

clusterArn

L'identifiant ARN du cluster élastique.

Obligatoire : oui

Corps de la demande

La demande n’a pas de corps de requête.

Syntaxe de la réponse

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

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

cluster

Renvoie des informations sur un cluster élastique spécifique.

Type : objet Cluster

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.

message

Un message d'erreur expliquant pourquoi l'accès a été refusé.

Code d’état HTTP : 403

InternalServerException

Une erreur interne s'est produite au niveau du serveur.

Code d’état HTTP : 500

ResourceNotFoundException

La ressource spécifiée n'a pas pu être localisée.

message

Un message d'erreur décrivant l'échec.

resourceId

L'ID de la ressource qui n'a pas pu être localisée.

resourceType

Type de ressource introuvable.

Code d’état HTTP : 404

ThrottlingException

ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.

retryAfterSeconds

Le nombre de secondes à attendre avant de réessayer l'opération.

Code d’état HTTP : 429

ValidationException

Structure définissant une exception de validation.

fieldList

Liste des champs dans lesquels l'exception de validation s'est produite.

message

Message d'erreur décrivant l'exception de validation.

reason

La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : unknownOperation cannotParsefieldValidationFailed,, ouother).

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :