RestoreClusterFromSnapshot - Amazon DocumentDB
Sintassi della richiestaParametri della richiesta URICorpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

RestoreClusterFromSnapshot

Ripristina un cluster elastico da un'istantanea.

Sintassi della richiesta

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

Parametri della richiesta URI

La richiesta utilizza i seguenti parametri URI.

snapshotArn

L'identificatore ARN dello snapshot del cluster elastico.

Campo obbligatorio: sì

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

clusterName

Il nome del cluster elastico.

Tipo: stringa

Campo obbligatorio: sì

kmsKeyId

L'identificatore di chiave KMS da utilizzare per crittografare il nuovo cluster elastico di cluster Amazon DocumentDB.

L'identificatore della chiave KMS è l'Amazon Resource Name (ARN) per la chiave di crittografia KMS. Se stai creando un cluster utilizzando lo stesso account Amazon che possiede questa chiave di crittografia KMS, puoi utilizzare l'alias della chiave KMS anziché l'ARN come chiave di crittografia KMS.

Se non viene specificata una chiave di crittografia qui, Amazon DocumentDB utilizza la chiave di crittografia predefinita creata da KMS per il tuo account. Il tuo account ha una chiave di crittografia predefinita diversa per ogni regione Amazon.

▬Tipo: stringa

Campo obbligatorio: no

shardCapacity

La capacità di ogni shard nel nuovo cluster elastico ripristinato.

Tipo: integer

Campo obbligatorio: no

shardInstanceCount

Il numero di istanze di replica che si applicano a tutti gli shard del cluster elastico. shardInstanceCountIl valore 1 indica che esiste un'istanza di writer e tutte le istanze aggiuntive sono repliche che possono essere utilizzate per le letture e per migliorare la disponibilità.

Tipo: integer

Campo obbligatorio: no

subnetIds

Gli ID di sottorete Amazon EC2 per il cluster elastico.

Tipo: matrice di stringhe

Campo obbligatorio: no

tags

Un elenco dei nomi di tag da assegnare al cluster elastico ripristinato, sotto forma di una matrice di coppie chiave-valore in cui la chiave è il nome del tag e il valore è il valore chiave.

Tipo: mappatura stringa a stringa

Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.

Modello di chiave:^(?!aws:)[a-zA-Z+-=._:/]+$

Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.

Campo obbligatorio: no

vpcSecurityGroupIds

Un elenco di gruppi di sicurezza VPC EC2 da associare al cluster elastico.

Tipo: matrice di stringhe

Campo obbligatorio: no

Sintassi della risposta

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

cluster

Restituisce informazioni su un cluster elastico ripristinato.

Tipo: oggetto Cluster

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

AccessDeniedException

Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.

Codice di stato HTTP: 403

ConflictException

Si è verificato un conflitto di accesso.

Codice di stato HTTP: 409

InternalServerException

Si è verificato un errore interno del server.

Codice di stato HTTP: 500

ResourceNotFoundException

Impossibile trovare la risorsa specificata.

Codice di stato HTTP: 404

ServiceQuotaExceededException

La quota di servizio per l'azione è stata superata.

Codice di stato HTTP: 402

ThrottlingException

ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.

Codice di stato HTTP: 429

ValidationException

Una struttura che definisce un'eccezione di convalida.

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: