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

CreateClusterSnapshot

Crée un instantané d'un cluster élastique.

Syntaxe de la demande

POST /cluster-snapshot HTTP/1.1
Content-type: application/json

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

clusterArn

Identifiant ARN du cluster élastique dont vous souhaitez créer un instantané.

Type : String

Obligatoire : oui

snapshotName

Nom du nouvel instantané du cluster élastique.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.

Obligatoire : oui

tags

Les balises à attribuer au nouvel instantané du cluster élastique.

Type : mappage chaîne/chaîne

Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.

Modèle de clé :(?!aws:)[a-zA-Z+-=._:/]+

Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "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.

snapshot

Renvoie des informations sur le nouvel instantané du cluster élastique.

Type : objet ClusterSnapshot

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

ConflictException

Il y a eu un conflit d'accès.

resourceId

L'ID de la ressource où il y a eu un conflit d'accès.

resourceType

Type de ressource ayant fait l'objet d'un conflit d'accès.

Code d’état HTTP : 409

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

resourceType

Type de ressource introuvable.

Code d’état HTTP : 404

ServiceQuotaExceededException

Le quota de service pour l'action a été dépassé.

Code d'état HTTP : 402

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 :