CopyClusterSnapshot - Amazon DocumentDB
Sintaxis de la solicitudURIParámetros de solicitudCuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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.

CopyClusterSnapshot

Copia una instantánea de un clúster elástico.

Sintaxis de la solicitud

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

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}

URIParámetros de solicitud

La solicitud utiliza los siguientes URI parámetros.

snapshotArn

El identificador del nombre de recurso de Amazon (ARN) de la instantánea del clúster elástico.

Obligatorio: sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en JSON formato.

targetSnapshotName

El identificador de la nueva instantánea del clúster elástico que se va a crear a partir de la instantánea del clúster de origen. Este parámetro no distingue entre mayúsculas y minúsculas.

Restricciones:

  • Deben contener de 1 a 63 caracteres (letras, números o guiones).

  • El primer carácter debe ser una letra.

  • No puede terminar por un guion ni contener dos guiones consecutivos.

Ejemplo: elastic-cluster-snapshot-5

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.

Obligatorio: sí

copyTags

Configúrelo true para copiar todas las etiquetas de la instantánea del clúster de origen a la instantánea del clúster elástico de destino. El valor predeterminado es false.

Tipo: Booleano

Obligatorio: no

kmsKeyId

El ID AWS KMS clave de una instantánea de clúster elástico cifrada. El ID de AWS KMS clave es el nombre del recurso de Amazon (ARN), el identificador de AWS KMS clave o el alias de AWS KMS clave de la clave de AWS KMS cifrado.

Si copia una instantánea de un clúster elástico cifrada de su AWS cuenta, puede especificar un valor KmsKeyId para cifrar la copia con una nueva clave de KMS cifrado AWS S. Si no especifica un valor paraKmsKeyId, la copia de la instantánea del clúster elástico se cifra con la misma AWS KMS clave que la instantánea del clúster elástico de origen.

Si copia una instantánea de un clúster elástico sin cifrar y especifica un valor para el KmsKeyId parámetro, se devuelve un error.

Tipo: cadena

Requerido: no

tags

Las etiquetas que se van a asignar a la instantánea del clúster elástico.

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.

Obligatorio: no

Sintaxis de la respuesta

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

snapshot

Devuelve información sobre una instantánea específica del clúster elástico.

Tipo: objeto ClusterSnapshot

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.

HTTPCódigo de estado: 403

ConflictException

Se ha producido un conflicto de acceso.

HTTPCódigo de estado: 409

InternalServerException

Se ha producido un error en el servidor interno.

HTTPCódigo de estado: 500

ResourceNotFoundException

No se pudo encontrar el recurso especificado.

HTTPCódigo de estado: 404

ServiceQuotaExceededException

Se ha superado la cuota de servicio para la acción.

HTTPCódigo de estado: 402

ThrottlingException

ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.

HTTPCódigo de estado: 429

ValidationException

Estructura que define una excepción de validación.

HTTPCódigo de estado: 400

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: