ListBackupVaults - AWS Backup
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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á.

ListBackupVaults

Retorna uma lista de contêineres de armazenamento de pontos de recuperação junto com informações sobre eles.

Sintaxe da Solicitação

GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

ByShared

Esse parâmetro classificará a lista de cofres por cofres compartilhados.

ByVaultType

Esse parâmetro classificará a lista de cofres por tipo de cofre.

Valores Válidos: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

MaxResults

O número máximo de itens a serem retornados.

Intervalo válido: valor mínimo de 1. Valor máximo de 1.000.

NextToken

O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar o número MaxResults de itens, o NextToken permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultList": [ 
      { 
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "EncryptionKeyArn": "string",
         "LockDate": number,
         "Locked": boolean,
         "MaxRetentionDays": number,
         "MinRetentionDays": number,
         "NumberOfRecoveryPoints": number
      }
   ],
   "NextToken": "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.

BackupVaultList

Uma matriz de membros da lista de cofres de backup contendo metadados do cofre, incluindo o Nome do recurso da Amazon (ARN), o nome de exibição, a data de criação, o número de pontos de recuperação salvos e informações de criptografia se os recursos salvos no cofre de backup estiverem criptografados.

Tipo: matriz de objetos BackupVaultListMember

NextToken

O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar o número MaxResults de itens, o NextToken permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

Tipo: sequência

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 AWS SDKs específicos da linguagem, consulte o seguinte: