DescribeBackupVault
Retorna metadados sobre um cofre de backup especificado por seu nome.
Sintaxe da Solicitação
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- BackupVaultAccountId
-
O ID da conta do cofre de backup especificado.
- backupVaultName
-
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Obrigatório: Sim
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number,
"CreatorRequestId": "string",
"EncryptionKeyArn": "string",
"LockDate": number,
"Locked": boolean,
"MaxRetentionDays": number,
"MinRetentionDays": number,
"NumberOfRecoveryPoints": number,
"VaultState": "string",
"VaultType": "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.
- BackupVaultArn
-
Um Nome do recurso da Amazon (ARN) que identifica exclusivamente um cofre de backup, por exemplo,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.Tipo: string
- BackupVaultName
-
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da em que são criados.
Tipo: string
- CreationDate
-
A data e hora em que o cofre de backup foi criado, em formato de hora Unix e Tempo Universal Coordenado (UTC). O valor de
CreationDatetem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: carimbo de data/hora
- CreatorRequestId
-
Uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Esse parâmetro é opcional. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-_” .
Tipo: string
- EncryptionKeyArn
-
A chave de criptografia no lado do servidor usada para proteger seus backups, por exemplo,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.Tipo: string
- LockDate
-
A data e a hora em que a configuração do AWS Backup Vault Lock não pode ser alterada ou excluída.
Se tiver aplicado o Vault Lock ao seu cofre sem especificar uma data de bloqueio, você poderá alterar qualquer uma das configurações do Vault Lock ou excluir totalmente o Vault Lock do cofre, a qualquer momento.
Esse valor está no formato Unix, Tempo Universal Coordenado (UTC) e tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: carimbo de data/hora
- Locked
-
Um booliano que indica se o AWS Backup Vault Lock está protegendo o cofre de backup no momento.
Truesignifica que o Vault Lock faz com que haja falha nas operações de exclusão ou de atualização nos pontos de recuperação armazenados no cofre.Tipo: booliano
- MaxRetentionDays
-
A configuração do AWS Backup Vault Lock que especifica o período máximo de retenção que o cofre retém seus pontos de recuperação. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período máximo de retenção nos pontos de recuperação no cofre (permitindo o armazenamento indefinido).
Se esse parâmetro for especificado, qualquer trabalho de backup ou de cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou inferior ao período máximo de retenção. Se o período de retenção do trabalho for maior do que o período máximo de retenção, haverá falha no trabalho de backup ou de cópia do cofre e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. Os pontos de recuperação já armazenados no cofre antes do Vault Lock não serão afetados.
Tipo: longo
- MinRetentionDays
-
A configuração do AWS Backup Vault Lock que especifica o período mínimo de retenção que o cofre retém seus pontos de recuperação. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período mínimo de retenção.
Se esse parâmetro for especificado, qualquer trabalho de backup ou de cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou superior ao período mínimo de retenção. Se o período de retenção do trabalho for inferior do que o período mínimo de retenção, haverá falha do cofre no trabalho de backup ou de cópia e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. Os pontos de recuperação já armazenados no cofre antes do Vault Lock não serão afetados.
Tipo: longo
- NumberOfRecoveryPoints
-
O número de pontos de recuperação armazenados em um cofre de backup.
Tipo: longo
- VaultState
-
O estado atual do cofre.->
Tipo: string
Valores Válidos:
CREATING | AVAILABLE | FAILED - VaultType
-
O tipo de cofre descrito.
Tipo: string
Valores Válidos:
BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
Código de Status HTTP: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
Código de Status HTTP: 400
- ResourceNotFoundException
-
Um recurso necessário para a ação não existe.
Código de Status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
Código de Status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
