Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
RestoreClusterFromSnapshot
Restaura un clúster elástico desde una instantánea.
Sintaxis de la solicitud
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
" ]
}
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- snapshotArn
-
El identificador ARN de la instantánea del clúster elástico.
Obligatorio: sí
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- clusterName
-
El nombre del clúster elástico.
Tipo: cadena
Obligatorio: sí
- kmsKeyId
-
El identificador de clave de KMS que se debe utilizar para cifrar el nuevo clúster elástico de Amazon DocumentDB.
El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando un clúster con la misma cuenta de Amazon a la que pertenece esta clave de cifrado de KMS, puede utilizar el alias de la clave de KMS en lugar del ARN como clave de cifrado de KMS.
Si no se especifica una clave de cifrado, Amazon DocumentDB utiliza la clave de cifrado predeterminada que KMS crea para la cuenta. Su cuenta dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.
Tipo: cadena
Requerido: no
- shardCapacity
-
La capacidad de cada partición del nuevo clúster elástico restaurado.
Tipo: entero
Requerido: no
- shardInstanceCount
-
El número de instancias de réplica que se aplica a todas las particiones del clúster elástico. Un valor de
shardInstanceCount
igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.Tipo: entero
Requerido: no
- subnetIds
-
Los ID de subredes de Amazon EC2 para el clúster elástico.
Tipo: matriz de cadenas
Requerido: no
-
Una lista de los nombres de etiquetas que se van a asignar al clúster elástico restaurado, en forma de una matriz de pares clave-valor, en la que la clave es el nombre de la etiqueta y el valor es el valor de la clave.
Tipo: mapa de cadena a cadena
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.
Patrón de clave:
^(?!aws:)[a-zA-Z+-=._:/]+$
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.
Requerido: no
- vpcSecurityGroupIds
-
Una lista de grupos de seguridad de VPC de EC2 para asociar al clúster elástico.
Tipo: matriz de cadenas
Requerido: no
Sintaxis de la respuesta
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 respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.
Código de estado HTTP: 403
- ConflictException
-
Se ha producido un conflicto de acceso.
Código de estado HTTP: 409
- InternalServerException
-
Se ha producido un error en el servidor interno.
Código de estado HTTP: 500
- ResourceNotFoundException
-
No se pudo encontrar el recurso especificado.
Código de estado HTTP: 404
- ServiceQuotaExceededException
-
Se ha superado la cuota de servicio para la acción.
Código de estado HTTP: 402
- ThrottlingException
-
Se lanzará ThrottlingException cuando se deniegue la solicitud debido a la limitación de la solicitud.
Código de estado HTTP: 429
- ValidationException
-
Estructura que define una excepción de validación.
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte: