DescribeVaults - Cloud Backup: Central de Documentação do Alibaba Cloud

Obtém informações sobre um ou mais cofres de backup que atendem às condições especificadas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hbr:DescribeVaults

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VaultId	string	Não	O ID do cofre de backup.	v-*********************
VaultRegionId	string	Não	O ID da região do cofre de backup.	cn-shanghai
Status	string	Não	O status do cofre de backup. Valores válidos: UNKNOWN: desconhecido INITIALIZING: inicializando CREATED: criado ERROR: erro	CREATED
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor mínimo: 1. Valor máximo: 99. Valor padrão: 10.	10
VaultType	string	Não	O tipo do cofre de backup. Valores válidos.	STANDARD
Tag	array<object>	Não	As informações da tag. São suportadas no máximo 20 tags.	6a745bceffb042959b3b5206d6f12ad1
	object	Não	As informações da tag.
Key	string	Não	A chave da tag.	key1
Value	string	Não	O valor da tag.	value1
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-*********************
VaultName	string	Não	O nome do cofre de backup. O nome deve ter de 1 a 64 caracteres.	vaultname
VaultOwnerId	integer	Não	O ID da conta à qual o cofre de backup pertence.	144******732
Replication	boolean	Não	Especifica se devem ser consultados os cofres de destino de replicação.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Code	string	O código de retorno. Um valor 200 indica sucesso.	200
Message	string	A mensagem retornada. O valor "successful" é retornado para uma solicitação bem-sucedida. Uma mensagem de erro é retornada para uma solicitação com falha.	successful
PageNumber	integer	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valor mínimo: 1. Valor máximo: 99. Valor padrão: 10.	10
TotalCount	integer	O número total de cofres de backup retornados.	8
Vaults	object		{'Vault': []}
Vault	array<object>	A lista de cofres de backup.	{'Vault': []}
	array<object>	A lista de cofres de backup.
Status	string	O status do cofre de backup. UNKNOWN: O status é desconhecido. INITIALIZING: O cofre de backup está sendo inicializado. CREATED: O cofre de backup foi criado. ERROR: Ocorreu um erro.	CREATED
VaultId	string	O ID do cofre de backup.	v-*********************
ChargeType	string	O método de cobrança do cofre de backup.	FREE
VaultType	string	O tipo do cofre de backup. O valor é fixo como STANDARD, o que indica um cofre de backup padrão.	STANDARD
Dedup	boolean	Indica se o recurso de deduplicação está ativado.	true
ReplicationSourceVaultId	string	O ID do cofre de origem para georredudância.	v-*********************
IndexUpdateTime	integer	A hora em que o índice foi atualizado.	1639645628
Description	string	A descrição do cofre.	vault description
VaultStorageClass	string	A classe de armazenamento do cofre de backup. O valor é fixo como STANDARD.	STANDARD
Retention	integer	O período de retenção do cofre de backup. Unidade: dias.	2
CreatedTime	integer	A hora em que o cofre de backup foi criado. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.	1554347313
IndexLevel	string	O nível do índice. OFF: Nenhum índice é criado. META: Um índice de metadados é criado. ALL: Um índice de texto completo é criado.	OFF
VaultName	string	O nome do cofre de backup.	vaultname
StorageSize	integer	O uso do cofre de backup. Unidade: bytes.	10
LatestReplicationTime	integer	A hora da última sincronização de georredudância. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.	1554347313
VaultStatusMessage	string	A mensagem de erro para o cofre georredudante. Este parâmetro é válido apenas para cofres georredudantes. Valores válidos: UNKNOWN_ERROR: Ocorreu um erro desconhecido. SOURCE_VAULT_ALREADY_HAS_REPLICATION: Outro destino de replicação está configurado para o cofre de origem.	SOURCE_VAULT_ALREADY_HAS_REPLICATION
Replication	boolean	Indica se o cofre é um cofre georredudante. true: O cofre é um cofre georredudante. false: O cofre é um cofre de backup local.	false
ReplicationSourceRegionId	string	O ID da região onde reside o cofre de origem do cofre georredudante. Este parâmetro é válido apenas para cofres georredudantes.	cn-shanghai
VaultRegionId	string	O ID da região onde o cofre de backup reside.	cn-shanghai
UpdatedTime	integer	A hora em que o cofre de backup foi atualizado. Este valor é um carimbo de data/hora UNIX. Unidade: segundos.	1554347313
ResourceGroupId	string	O ID do grupo de recursos.	rg-*********************
BucketName	string	O nome do bucket do Object Storage Service (OSS) usado para o cofre de backup.	hbr-0005i51******t58
SearchEnabled	boolean	Indica se o recurso de pesquisa de backup está ativado.	true
IndexAvailable	boolean	Indica se o índice está disponível. Um índice está disponível quando não está sendo atualizado.	true
BytesDone	integer	O tamanho dos dados de backup. Unidade: bytes.	20
Tags	object
Tag	array<object>	As tags do cofre de backup.
	object	As tags do cofre de backup.
Key	string	A chave da tag do cofre. A chave não pode começar com `aliyun` ou `acs:`. A chave não pode conter `http://` ou `https://`. A chave não pode ser uma string vazia.	aaa
Value	string	O valor da tag do cofre. O valor não pode começar com `aliyun` ou `acs:`. O valor não pode conter `http://` ou `https://`. O valor não pode ser uma string vazia.	a1
SourceTypes	object
SourceType	array	Os tipos de fontes de dados que são submetidas a backup no cofre.
	string	O tipo da fonte de dados.	ECS_FILE
ReplicationProgress	object	O progresso de replicação do cofre de backup.
HistoricalReplicationProgress	integer	O progresso de replicação de dados históricos no cofre de backup. Valores válidos: 0 a 100.	100
NewReplicationProgress	integer	A hora de replicação mais recente de dados incrementais no cofre de backup.	1579413159
BackupPlanStatistics	object	As estatísticas dos planos de backup para o cofre de backup.
Oracle	integer	O número de planos de backup do Oracle.	1
LocalFile	integer	O número de planos de backup para servidores locais.	1
Nas	integer	O número de planos de backup do NAS.	1
CommonNas	integer	O número de planos de backup para sistemas de arquivos NAS de uso geral.	1
Isilon	integer	O número de planos de backup do Isilon.	1
Oss	integer	O número de planos de backup do OSS.	1
SqlServer	integer	O número de planos de backup do SQL Server.	1
Csg	integer	O número de planos de backup do Cloud Storage Gateway (CSG).	1
EcsFile	integer	O número de planos de backup de arquivos ECS.	1
MySql	integer	O número de planos de backup do MySQL.	1
EcsHana	integer	O número de planos de backup do SAP HANA.	1
LocalVm	integer	O número de planos de backup para máquinas virtuais locais.	1
Ots	integer	O número de planos de backup do Tablestore.	1
Archive	integer	O número de planos de arquivamento.	1
CommonFileSystem	integer	O número de planos de backup do Cloud Paralleled File System (CPFS).	1
TrialInfo	object	As propriedades da avaliação gratuita.
TrialStartTime	integer	A hora de início da avaliação gratuita.	1579413159
TrialVaultReleaseTime	integer	A hora em que o cofre de backup de avaliação é liberado.	1594965600
TrialExpireTime	integer	A hora de expiração da avaliação gratuita.	1584597600
KeepAfterTrialExpiration	boolean	Indica se o cofre de backup é convertido em um cofre pós-pago após o término da avaliação gratuita.	true
EncryptType	string	O tipo de criptografia do cofre de backup. NONE: Nenhuma criptografia é usada. HBR_PRIVATE: O cofre de backup é criptografado usando uma chave gerenciada pelo Hybrid Backup Recovery (HBR). Este é o valor padrão. KMS: O cofre de backup é criptografado usando uma chave gerenciada pelo Key Management Service (KMS).	HBR_PRIVATE
WormEnabled	boolean	Indica se o bloqueio de backup está ativado.	true
SnapshotCount	integer	O número de snapshots no cofre.	0
CompressionAlgorithm	string	O algoritmo de compactação usado para o cofre de backup. Valores válidos: DISABLED: A compactação está desativada. SNAPPY: O algoritmo SNAPPY é usado. ZSTD: O algoritmo Zstandard é usado. O Zstandard é um algoritmo de compactação rápido e sem perdas.	ZSTD
RedundancyType	string	O tipo de redundância de dados do cofre de backup. Valores válidos: LRS: armazenamento localmente redundante (LRS). O HBR armazena cópias redundantes dos seus dados em vários dispositivos na mesma zona para garantir a durabilidade e a disponibilidade dos dados em caso de falhas de hardware. ZRS: armazenamento com redundância de zona (ZRS). O HBR usa um mecanismo multizona para distribuir seus dados em três zonas dentro da mesma região. Isso garante que seus dados permaneçam acessíveis mesmo se uma zona ficar indisponível.	LRS
KmsKeyId	string	O ID da chave mestra do cliente (CMK) ou o alias da CMK que é usado para criptografia KMS. Este parâmetro é necessário apenas se você definir EncryptType como KMS.	alias/acs/acm
ChargedStorageSize	integer	O uso de armazenamento faturável do cofre de arquivamento. Unidade: bytes.	1024000
ArchiveStorageSize	integer	O uso de armazenamento faturável da classe de armazenamento Archive. Unidade: bytes.	1024000
ArchiveBytesDone	integer	O tamanho dos dados de backup da classe de armazenamento Archive. Unidade: bytes.	1024000
ReplicationSourceVault	boolean	Indica se o cofre é um cofre de origem para georredudância. true: O cofre é um cofre de origem para georredudância. false: O cofre não é um cofre de origem para georredudância.	false
ReplicationTargetRegionId	string	A região de destino para georredudância.	cn-shanghai
VaultOwnerId	integer	O ID da conta que possui o armazenamento de dados.	123***7890
ReplicationTargetVaultId	string	O ID do cofre de destino de replicação.	v-123***7890
ReplicationSourceOwnerId	integer	O ID da conta de origem para replicação.	123***7890
ReplicationTargetOwnerId	integer	O ID da conta que possui o cofre de destino de replicação.	123***7890
ReplicationStatus	string	O status de replicação do cofre de destino de replicação.	RUNNING
RsTargetAccountIds	object
RsTargetAccountId	array	A conta de destino para compartilhamento de recursos.
	integer	A conta de destino para compartilhamento de recursos.	123***7890

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Vaults": {
    "Vault": [
      {
        "Status": "CREATED",
        "VaultId": "v-*********************",
        "ChargeType": "FREE",
        "VaultType": "STANDARD",
        "Dedup": true,
        "ReplicationSourceVaultId": "v-*********************",
        "IndexUpdateTime": 1639645628,
        "Description": "vault description",
        "VaultStorageClass": "STANDARD",
        "Retention": 2,
        "CreatedTime": 1554347313,
        "IndexLevel": "OFF",
        "VaultName": "vaultname",
        "StorageSize": 10,
        "LatestReplicationTime": 1554347313,
        "VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
        "Replication": false,
        "ReplicationSourceRegionId": "cn-shanghai",
        "VaultRegionId": "cn-shanghai",
        "UpdatedTime": 1554347313,
        "ResourceGroupId": "rg-*********************",
        "BucketName": "hbr-0005i51******t58",
        "SearchEnabled": true,
        "IndexAvailable": true,
        "BytesDone": 20,
        "Tags": {
          "Tag": [
            {
              "Key": "aaa",
              "Value": "a1"
            }
          ]
        },
        "SourceTypes": {
          "SourceType": [
            "ECS_FILE"
          ]
        },
        "ReplicationProgress": {
          "HistoricalReplicationProgress": 100,
          "NewReplicationProgress": 1579413159
        },
        "BackupPlanStatistics": {
          "Oracle": 1,
          "LocalFile": 1,
          "Nas": 1,
          "CommonNas": 1,
          "Isilon": 1,
          "Oss": 1,
          "SqlServer": 1,
          "Csg": 1,
          "EcsFile": 1,
          "MySql": 1,
          "EcsHana": 1,
          "LocalVm": 1,
          "Ots": 1,
          "Archive": 1,
          "CommonFileSystem": 1
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "EncryptType": "HBR_PRIVATE",
        "WormEnabled": true,
        "SnapshotCount": 0,
        "CompressionAlgorithm": "ZSTD",
        "RedundancyType": "LRS",
        "KmsKeyId": "alias/acs/acm",
        "ChargedStorageSize": 1024000,
        "ArchiveStorageSize": 1024000,
        "ArchiveBytesDone": 1024000,
        "ReplicationSourceVault": false,
        "ReplicationTargetRegionId": "cn-shanghai",
        "VaultOwnerId": 0,
        "ReplicationTargetVaultId": "v-123***7890",
        "ReplicationSourceOwnerId": 0,
        "ReplicationTargetOwnerId": 0,
        "ReplicationStatus": "RUNNING",
        "RsTargetAccountIds": {
          "RsTargetAccountId": [
            0
          ]
        }
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.