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

Descreve um ou mais cofres de backup que atendem aos critérios especificados.

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

*All Resource

*

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 onde o cofre de backup reside.	cn-shanghai
Status	string	Não	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
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. Valores válidos: 1 a 99. Valor padrão: 10.	10
VaultType	string	Não	O tipo do cofre de backup. Valores válidos: STANDARD: cofre de backup padrão. Este tipo de cofre pode ser usado para backup de arquivos ECS, backup do OSS e backup do NAS. OTS_BACKUP: cofre de backup do Tablestore. Este tipo de cofre é dedicado ao backup do Tablestore.	STANDARD
Tag	array<object>	Não	As tags. Você pode especificar no máximo 20 tags.	6a745bceffb042959b3b5206d6f12ad1
	object	Não	A 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 da Alibaba Cloud que possui o cofre de backup.	144******732
Replication	boolean	Não	Especifica se devem ser consultados os cofres de backup que são usados como destinos 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: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Code	string	O código de retorno. Um valor 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se a solicitação falhar, uma mensagem de erro será retornada.	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. Valores válidos: 1 a 99. Valor padrão: 10.	10
TotalCount	integer	O número total de cofres de backup retornados.	8
Vaults	object
Vault	array<object>	A lista de cofres de backup.	{'Vault': []}
	array<object>	A lista de cofres de backup.
Status	string	The status of the backup vault. UNKNOWN: The status is unknown. INITIALIZING: The backup vault is being initialized. CREATED: The backup vault has been created. ERROR: An error occurred.	CREATED
VaultId	string	The ID of the backup vault.	v-*********************
ChargeType	string	The billing method of the backup vault.	FREE
VaultType	string	The type of the backup vault. The value is fixed as STANDARD, which indicates a standard backup vault.	STANDARD
Dedup	boolean	Indicates whether the deduplication feature is enabled.	true
ReplicationSourceVaultId	string	The ID of the source vault for geo-redundancy.	v-*********************
IndexUpdateTime	integer	The time when the index was updated.	1639645628
Description	string	The description of the vault.	vault description
VaultStorageClass	string	The storage class of the backup vault. The value is fixed as STANDARD.	STANDARD
Retention	integer	The retention period of the backup vault. Unit: days.	2
CreatedTime	integer	The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.	1554347313
IndexLevel	string	The index level. OFF: No index is created. META: A metadata index is created. ALL: A full-text index is created.	OFF
VaultName	string	The name of the backup vault.	vaultname
StorageSize	integer	The usage of the backup vault. Unit: bytes.	10
LatestReplicationTime	integer	The time of the last geo-redundancy sync. This value is a UNIX timestamp. Unit: seconds.	1554347313
VaultStatusMessage	string	The error message for the geo-redundant vault. This parameter is valid only for geo-redundant vaults. Valid values: UNKNOWN_ERROR: An unknown error occurred. SOURCE_VAULT_ALREADY_HAS_REPLICATION: Another replication destination is configured for the source vault.	SOURCE_VAULT_ALREADY_HAS_REPLICATION
Replication	boolean	Indicates whether the vault is a geo-redundant vault. true: The vault is a geo-redundant vault. false: The vault is a local backup vault.	false
ReplicationSourceRegionId	string	The ID of the region where the source vault of the geo-redundant vault resides. This parameter is valid only for geo-redundant vaults.	cn-shanghai
VaultRegionId	string	The ID of the region where the backup vault resides.	cn-shanghai
UpdatedTime	integer	The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
ResourceGroupId	string	The ID of the resource group.	rg-*********************
BucketName	string	The name of the Object Storage Service (OSS) bucket used for the backup vault.	hbr-0005i51******t58
SearchEnabled	boolean	Indicates whether the backup search feature is enabled.	true
IndexAvailable	boolean	Indicates whether the index is available. An index is available when it is not being updated.	true
BytesDone	integer	The backup data size. Unit: bytes.	20
Tags	object
Tag	array<object>	The tags of the backup vault.
	object	The tags of the backup vault.
Key	string	The tag key of the vault. The key cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`. The key cannot be an empty string.	aaa
Value	string	The tag value of the vault. The value cannot start with `aliyun` or `acs:`. The value cannot contain `http://` or `https://`. The value cannot be an empty string.	a1
SourceTypes	object
SourceType	array	The types of data sources that are backed up to the vault.
	string	The type of the data source.	ECS_FILE
ReplicationProgress	object	The replication progress of the backup vault.
HistoricalReplicationProgress	integer	The replication progress of historical data in the backup vault. Valid values: 0 to 100.	100
NewReplicationProgress	integer	The most recent replication time of incremental data in the backup vault.	1579413159
BackupPlanStatistics	object	The statistics of backup plans for the backup vault.
Oracle	integer	The number of Oracle backup plans.	1
LocalFile	integer	The number of backup plans for on-premises servers.	1
Nas	integer	The number of NAS backup plans.	1
CommonNas	integer	The number of backup plans for general-purpose NAS file systems.	1
Isilon	integer	The number of Isilon backup plans.	1
Oss	integer	The number of OSS backup plans.	1
SqlServer	integer	The number of SQL Server backup plans.	1
Csg	integer	The number of Cloud Storage Gateway (CSG) backup plans.	1
EcsFile	integer	The number of ECS file backup plans.	1
MySql	integer	The number of MySQL backup plans.	1
EcsHana	integer	The number of SAP HANA backup plans.	1
LocalVm	integer	The number of backup plans for on-premises virtual machines.	1
Ots	integer	The number of Tablestore backup plans.	1
Archive	integer	The number of archive plans.	1
CommonFileSystem	integer	The number of Cloud Paralleled File System (CPFS) backup plans.	1
TrialInfo	object	The free trial properties.
TrialStartTime	integer	The start time of the free trial.	1579413159
TrialVaultReleaseTime	integer	The time when the trial backup vault is released.	1594965600
TrialExpireTime	integer	The expiration time of the free trial.	1584597600
KeepAfterTrialExpiration	boolean	Indicates whether the backup vault is converted to a pay-as-you-go vault after the free trial ends.	true
EncryptType	string	The encryption type of the backup vault. NONE: No encryption is used. HBR_PRIVATE: The backup vault is encrypted using a key that is managed by Hybrid Backup Recovery (HBR). This is the default value. KMS: The backup vault is encrypted using a key that is managed by Key Management Service (KMS).	HBR_PRIVATE
WormEnabled	boolean	Indicates whether backup locking is enabled.	true
SnapshotCount	integer	The number of snapshots in the vault.	0
CompressionAlgorithm	string	The compression algorithm that is used for the backup vault. Valid values: DISABLED: Compression is disabled. SNAPPY: The SNAPPY algorithm is used. ZSTD: The Zstandard algorithm is used. Zstandard is a fast, lossless compression algorithm.	ZSTD
RedundancyType	string	The data redundancy type of the backup vault. Valid values: LRS: locally redundant storage (LRS). HBR stores redundant copies of your data on multiple devices in the same zone to ensure data durability and availability in case of hardware failures. ZRS: zone-redundant storage (ZRS). HBR uses a multi-zone mechanism to distribute your data across three zones within the same region. This ensures that your data remains accessible even if a zone becomes unavailable.	LRS
KmsKeyId	string	The ID of the customer master key (CMK) or the alias of the CMK that is used for KMS encryption. This parameter is required only if you set EncryptType to KMS.	alias/acs/acm
ChargedStorageSize	integer	The billable storage usage of the archive vault. Unit: bytes.	1024000
ArchiveStorageSize	integer	The billable storage usage of the Archive storage class. Unit: bytes.	1024000
ArchiveBytesDone	integer	The backup data size of the Archive storage class. Unit: bytes.	1024000
ReplicationSourceVault	boolean	Indicates whether the vault is a source vault for geo-redundancy. true: The vault is a source vault for geo-redundancy. false: The vault is not a source vault for geo-redundancy.	false
ReplicationTargetRegionId	string	The destination region for geo-redundancy.	cn-shanghai
VaultOwnerId	integer	The ID of the account that owns the data store.	123***7890
ReplicationTargetVaultId	string	The ID of the replication destination vault.	v-123***7890
ReplicationSourceOwnerId	integer	The ID of the source account for replication.	123***7890
ReplicationTargetOwnerId	integer	The ID of the account that owns the replication destination vault.	123***7890
ReplicationStatus	string	The replication status of the replication destination vault.	RUNNING
RsTargetAccountIds	object
RsTargetAccountId	array	The destination account for resource sharing.
	integer	The destination account for resource sharing.	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.