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

RestoreClusterFromSnapshot

Restaure un cluster élastique à partir d'un instantané.

Syntaxe de la demande

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

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

snapshotArn

Identifiant ARN de l'instantané du cluster élastique.

Obligatoire : oui

Corps de la demande

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

clusterName

Nom de l'agrégat élastique.

Type : chaîne

Obligatoire : oui

kmsKeyId

Identifiant de clé KMS à utiliser pour chiffrer le nouveau cluster de clusters élastiques Amazon DocumentDB.

L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster en utilisant le même compte Amazon qui possède cette clé de chiffrement KMS, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN comme clé de chiffrement KMS.

Si aucune clé de chiffrement n'est spécifiée ici, Amazon DocumentDB utilise la clé de chiffrement par défaut créée par KMS pour votre compte. Votre compte possède une clé de chiffrement par défaut différente pour chaque région Amazon.

Type : chaîne

Obligatoire : non

shardCapacity

Capacité de chaque partition du nouveau cluster élastique restauré.

Type : entier

Obligatoire : non

shardInstanceCount

Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. Une shardInstanceCount valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.

Type : entier

Obligatoire : non

subnetIds

Les identifiants de sous-réseau Amazon EC2 pour le cluster élastique.

Type : tableau de chaînes

Obligatoire : non

tags

Une liste des noms de balises à attribuer au cluster élastique restauré, sous la forme d'un tableau de paires clé-valeur dans lequel la clé est le nom de balise et la valeur est la valeur clé.

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

vpcSecurityGroupIds

Liste des groupes de sécurité VPC EC2 à associer au cluster élastique.

Type : tableau de chaînes

Obligatoire : non

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 le cluster élastique restauré.

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.

Code d’état HTTP : 403

ConflictException

Il y a eu 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.

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.

Code d’état HTTP : 429

ValidationException

Structure définissant une exception de validation.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :