As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
RestoreClusterFromSnapshot
Para restaurar um cluster a partir de um snapshot
Sintaxe da Solicitação
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 da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- snapshotArn
-
O identificador ARN do snapshot do cluster elástico.
Obrigatório: Sim
Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
- clusterName
-
O nome do cluster.
Tipo: String
Obrigatório: Sim
- kmsKeyId
-
O identificador de chave KMS a ser usado para criptografar o novo cluster de clusters elásticos Amazon DocumentDB.
O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando um cluster usando a mesma conta da Amazon que possui essa chave de criptografia KMS, poderá usar o alias da chave KMS em vez do ARN como chave de criptografia KMS.
Se uma chave de criptografia não for especificada aqui, o Amazon DocumentDB usará a chave de criptografia padrão que o KMS cria para sua conta. Sua conta tem uma chave de criptografia padrão diferente para cada região da Amazon.
Tipo: String
Obrigatório: Não
- shardCapacity
-
A capacidade de cada fragmento no novo cluster elástico restaurado.
Tipo: inteiro
Obrigatório: não
- shardInstanceCount
-
O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em
shardInstanceCountsignifica que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.Tipo: inteiro
Obrigatório: não
- subnetIds
-
A EC2 sub-rede da Amazon IDs para o cluster elástico.
Tipo: matriz de strings
Obrigatório: Não
-
Uma lista dos nomes de tags a serem atribuídos ao cluster elástico restaurado, na forma de uma matriz de pares de valores-chave em que a chave é o nome da tag e o valor é o valor da chave.
Tipo: mapa de strings para string
Restrições de Tamanho de Chave: tamanho mínimo de 1. O tamanho máximo é 128.
Padrão da chave:
(?!aws:)[a-zA-Z+-=._:/]+Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.
Obrigatório: Não
- vpcSecurityGroupIds
-
Uma lista de grupos de segurança da EC2 VPC a serem associados ao cluster elástico.
Tipo: matriz de strings
Obrigatório: Não
Sintaxe da Resposta
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 Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
Erros
Para obter informações sobre os erros comuns a todas ações, consulte Erros comuns.
- AccessDeniedException
-
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.
- message
-
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403
- ConflictException
-
Houve um conflito de acesso.
- resourceId
-
O ID do recurso em que houve um conflito de acesso.
- resourceType
-
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409
- InternalServerException
-
Ocorreu um erro interno no servidor.
Código de Status HTTP: 500
- ResourceNotFoundException
-
O recurso especificado não foi localizado.
- message
-
Uma mensagem de erro descrevendo a falha.
- resourceId
-
O ID do recurso que não pôde ser localizado.
- resourceType
-
O tipo do recurso que não pôde ser encontrado.
Código de status HTTP: 404
- ServiceQuotaExceededException
-
O Service Quotas para a ação foi excedida.
Código de status HTTP: 402
- ThrottlingException
-
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.
- retryAfterSeconds
-
O número de segundos de espera antes de repetir a operação.
Código de Status HTTP: 429
- ValidationException
-
Uma estrutura que define uma exceção de validação.
- fieldList
-
Uma lista dos campos nos quais a exceção de validação ocorreu.
- message
-
Uma mensagem de erro descrevendo a exceção de validação.
- reason
-
O motivo pelo qual a exceção de validação ocorreu (um dos
unknownOperationcannotParse,fieldValidationFailed, ouother).
Código de Status HTTP: 400
Consulte Também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
