CopyClusterSnapshot - Amazon DocumentDB
Sintaxis de la solicitudParámetros de solicitud del URICuerpo 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"
}

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

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 formato JSON.

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

Establézcalo en true para copiar todas las etiquetas de la instantánea del clúster de origen a la instantánea del clúster de destino. El valor predeterminado es false.

Tipo: Booleano

Obligatorio: no

kmsKeyId

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

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 cifrado de AWS S KMS. Si no especifica ningún valor para KmsKeyId, la copia de la instantánea del clúster elástico se cifra con la misma clave de AWS KMS que la instantánea del clúster elástico de origen.

Si intenta copiar una instantánea del clúster elástico sin cifrar y especificar un valor para el parámetro KmsKeyId, 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 HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

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.

message

Un mensaje de error que explica por qué se denegó el acceso.

Código de estado HTTP: 403

ConflictException

Se ha producido un conflicto de acceso.

resourceId

El identificador del recurso en el que se produjo un conflicto de acceso.

resourceType

El tipo de recurso en el que se produjo 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.

message

Un mensaje de error que describe el error.

resourceId

El identificador del recurso que no se pudo localizar.

resourceType

El tipo de recurso que no se pudo encontrar.

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

ThrottlingException se lanzará cuando se rechace la solicitud debido a la limitación de la solicitud.

retryAfterSeconds

El número de segundos que hay que esperar antes de volver a intentar la operación.

Código de estado HTTP: 429

ValidationException

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

fieldList

Una lista de los campos en los que se produjo la excepción de validación.

message

Un mensaje de error que describe la excepción de validación.

reason

El motivo por el que se produjo la excepción de validación (uno de los siguientes: unknownOperation cannotParsefieldValidationFailed,, oother).

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente: