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

Consulta as informações de 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 à qual o cofre de backup pertence.	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 na página 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: Um cofre padrão. Pode ser usado para o ECS File Backup Standard Edition, backup do OSS e backup do NAS. OTS_BACKUP: Um cofre do Tablestore. Pode ser usado apenas para backup do Tablestore. O Tablestore exige este tipo de cofre.	STANDARD
Tag	array<object>	Não	As informações de tag. Há suporte para 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 os cofres de destino de replicação devem ser consultados.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de retorno. 200 indica sucesso.	200
Message	string	A mensagem retornada. "successful" é retornado para uma solicitação bem-sucedida, e a mensagem de erro correspondente é retornada se ocorrer um erro.	successful
PageNumber	integer	O número da página. As páginas começam na página 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
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falha.	true
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.
ArchiveBytesDone	integer	A quantidade de dados de backup na camada de arquivamento. Unidade: bytes.	1024000
ArchiveStorageSize	integer	A capacidade faturável da camada de arquivamento. Unidade: bytes.	1024000
BackupPlanStatistics	object	As estatísticas dos planos de backup no cofre de backup.
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
CommonNas	integer	O número de planos de backup de NAS de uso geral.	1
Cpfs	integer	O backup do CPFS.	3
Csg	integer	O número de planos de backup do Cloud Storage Gateway.	1
EcsFile	integer	O número de planos de backup do ECS File Backup Standard Edition.	1
EcsHana	integer	O número de planos de backup do SAP HANA.	1
Isilon	integer	O número de planos de backup do Isilon.	1
LocalFile	integer	O número de planos de backup para o tipo de serviço local.	1
LocalVm	integer	O número de planos de backup de máquinas virtuais locais.	1
MySql	integer	O número de planos de backup do MySQL.	1
Nas	integer	O número de planos de backup de NAS.	1
Oracle	integer	O número de planos de backup do Oracle.	1
Oss	integer	O número de planos de backup do OSS.	1
Ots	integer	O número de planos de backup do Tablestore.	1
SqlServer	integer	O número de planos de backup do SQL Server.	1
BucketName	string	O nome do bucket do OSS usado para a avaliação do cofre de backup.	hbr-0005i51******t58
BytesDone	integer	A quantidade de dados de backup. Unidade: bytes.	20
ChargeType	string	O método de cobrança do cofre de backup.	FREE
ChargedStorageSize	integer	A capacidade faturável do cofre de arquivamento. Unidade: bytes.	1024000
CompressionAlgorithm	string	O algoritmo de criptografia usado para compactar o cofre de backup. Valores válidos: DISABLED: Sem compactação ou criptografia. SNAPPY: Usa o algoritmo de criptografia SNAPPY. ZSTD: Zstandard, um algoritmo de compactação rápida sem perdas.	ZSTD
CreatedTime	integer	A hora em que o cofre de backup foi criado. O valor é um carimbo de data/hora UNIX em segundos.	1554347313
Dedup	boolean	Indica se o recurso de desduplicação de dados está ativado.	true
Description	string	A descrição do cofre.	vault description
EncryptType	string	O tipo de criptografia do cofre de backup. Valores válidos: NONE: Não criptografado. HBR_PRIVATE: O Cloud Backup fornece criptografia de chave secreta (padrão). KMS: Criptografado usando uma chave KMS gerenciada pelo cliente.	HBR_PRIVATE
IndexAvailable	boolean	Indica se o índice está disponível e não está sendo atualizado.	true
IndexLevel	string	O nível do índice. Valores válidos: OFF: Nenhum índice é criado. META: Índice de metadados. ALL: Índice de texto completo.	OFF
IndexUpdateTime	integer	A hora em que o índice foi atualizado.	1639645628
KmsKeyId	string	O ID ou alias da chave personalizada no Key Management Service (KMS). Este parâmetro é necessário apenas quando EncryptType está definido como KMS.	alias/acs/acm
LatestReplicationTime	integer	A hora da última sincronização de backup com redundância geográfica. O valor é um carimbo de data/hora UNIX em segundos.	1554347313
RedundancyType	string	O tipo de redundância de dados do cofre de backup. Valores válidos: LRS: Armazenamento com redundância local (LRS). O LRS armazena várias cópias 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 ZRS armazena seus dados em três zonas na mesma região. Seus dados permanecem acessíveis mesmo se uma zona ficar indisponível.	LRS
Replication	boolean	Indica se o cofre de backup é um cofre de backup com redundância geográfica. Valores válidos: true: O cofre de backup é um cofre de backup com redundância geográfica. false: O cofre de backup é um cofre de backup local.	false
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 da última replicação de dados incrementais no cofre de backup.	1579413159
ReplicationSourceOwnerId	integer	O ID da conta de origem para replicação.	123***7890
ReplicationSourceRegionId	string	O ID da região do cofre de backup de origem para o cofre de backup com redundância geográfica. Este parâmetro é válido apenas para cofres de backup com redundância geográfica.	cn-shanghai
ReplicationSourceVault	boolean	Indica se o cofre de backup é o cofre de backup de origem de um cofre de backup com redundância geográfica. Valores válidos: true: O cofre de backup é o cofre de backup de origem de um cofre de backup com redundância geográfica. false: O cofre de backup não é o cofre de backup de origem de um cofre de backup com redundância geográfica.	false
ReplicationSourceVaultId	string	O ID do cofre de backup de origem para o cofre de backup com redundância geográfica.	v-*********************
ReplicationStatus	string	O status de replicação do cofre de destino da replicação.	RUNNING
ReplicationTargetOwnerId	integer	O ID da conta à qual o cofre de destino da replicação pertence.	123***7890
ReplicationTargetRegionId	string	A região de destino do cofre de backup com redundância geográfica.	cn-shanghai
ReplicationTargetVaultId	string	O ID do cofre de destino da replicação.	v-123***7890
ResourceGroupId	string	O ID do grupo de recursos.	rg-*********************
Retention	integer	O período de retenção do cofre de backup. Unidade: dias.	2
RsTargetAccountIds	object
RsTargetAccountId	array	A conta de destino para compartilhamento de recursos.
	integer	A conta de destino para compartilhamento de recursos.	123***7890
SearchEnabled	boolean	Indica se o recurso de pesquisa de backup está ativado.	true
SnapshotCount	integer	O número de snapshots no cofre.	0
SourceTypes	object
SourceType	array	O tipo da fonte de dados armazenada em backup no cofre de backup.
	string	O tipo da fonte de dados de backup.	ECS_FILE
Status	string	O status do cofre de backup. Valores válidos: UNKNOWN: Desconhecido. INITIALIZING: Inicializando. CREATED: Criado. ERROR: Erro.	CREATED
StorageSize	integer	O uso de armazenamento do cofre de backup. Unidade: bytes.	10
Tags	object
Tag	array<object>	As informações de tag do cofre de backup.
	object	As informações de tag do cofre de backup.
Key	string	A chave da tag do cofre. Valores válidos de N: 1 a 20. 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. Valores válidos de N: 1 a 20. 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
TrialInfo	object	Os atributos da avaliação gratuita.
KeepAfterTrialExpiration	boolean	Indica se o método de cobrança é alterado para pay-as-you-go após a expiração da avaliação gratuita.	true
TrialExpireTime	integer	A hora de expiração da avaliação gratuita.	1584597600
TrialStartTime	integer	A hora de início da avaliação gratuita.	1579413159
TrialVaultReleaseTime	integer	A hora de liberação do cofre de avaliação gratuita.	1594965600
UpdatedTime	integer	A hora em que o cofre de backup foi atualizado. O valor é um carimbo de data/hora UNIX em segundos.	1554347313
VaultId	string	O ID do cofre de backup.	v-*********************
VaultName	string	O nome do cofre de backup.	vaultname
VaultOwnerId	integer	O ID da conta à qual o cofre pertence.	123***7890
VaultRegionId	string	O ID da região à qual o cofre de backup pertence.	cn-shanghai
VaultStatusMessage	string	(Válido apenas para cofres de backup com georredudância) A mensagem de status de erro do cofre. Valores válidos: UNKNOWN_ERROR: Ocorreu um erro desconhecido. SOURCE_VAULT_ALREADY_HAS_REPLICATION: O cofre de origem para replicação já está configurado com outro cofre espelho.	SOURCE_VAULT_ALREADY_HAS_REPLICATION
VaultStorageClass	string	A classe de armazenamento do cofre de backup. O único valor válido é STANDARD, que indica armazenamento padrão.	STANDARD
VaultType	string	O tipo do cofre de backup. O único valor válido é STANDARD, que indica um cofre padrão.	STANDARD
WormEnabled	boolean	Indica se o recurso de bloqueio de backup está ativado.	true

Exemplos

Resposta de sucesso

JSON formato

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

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.