All Products
Search
Document Center

Cloud Backup:DescribeVaults

Last Updated:Mar 03, 2024

Queries the information about one or more backup vaults that meet the specified conditions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Vaultsobject []

The backup vaults.

{'Vault': []}
Statusstring

The status of the backup vault. Valid values:

  • UNKNOWN: The backup vault is in an unknown state.
  • INITIALIZING: The backup vault is being initialized.
  • CREATED: The backup vault is created.
  • ERROR: An error occurs on the backup vault.
CREATED
VaultIdstring

The ID of the backup vault.

v-*********************
ChargeTypestring

The billing method of the backup vault.

FREE
VaultTypestring

The type of the backup vault. Only STANDARD may be returned, which indicates a standard backup vault.

STANDARD
Dedupboolean

Indicates whether the deduplication feature is enabled.

true
ReplicationSourceVaultIdstring

The ID of the source vault that corresponds to the remote backup vault.

v-*********************
IndexUpdateTimelong

The time when the index was updated.

1639645628
Descriptionstring

The description of the backup vault.

vault description
VaultStorageClassstring

The storage type of the backup vault. Only STANDARD may be returned, which indicates standard storage.

STANDARD
Retentionlong

The retention period of the backup vault. Unit: day.

2
CreatedTimelong

The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.

1554347313
IndexLevelstring

The index level.

  • OFF: No indexes are created.
  • META: Metadata indexes are created.
  • ALL: Full-text indexes are created.
OFF
VaultNamestring

The name of the backup vault.

vaultname
StorageSizelong

The usage of the backup vault. Unit: bytes.

10
LatestReplicationTimelong

The time when the last remote backup was synchronized. This value is a UNIX timestamp. Unit: seconds.

1554347313
VaultStatusMessagestring

The status message that is returned when the backup vault is in the ERROR state. This parameter is valid only for remote backup vaults. Valid values:

  • UNKNOWN_ERROR: An unknown error occurs.
  • SOURCE_VAULT_ALREADY_HAS_REPLICATION: A mirror vault is configured for the source vault.
SOURCE_VAULT_ALREADY_HAS_REPLICATION
Replicationboolean

Indicates whether the backup vault is a remote backup vault. Valid values:

  • true: The backup vault is a remote backup vault.
  • false: The backup vault is an on-premises backup vault.
false
ReplicationSourceRegionIdstring

The ID of the region in which the remote backup vault resides.

v-*********************
VaultRegionIdstring

The ID of the region in which the backup vault resides.

cn-shanghai
UpdatedTimelong

The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.

1554347313
ResourceGroupIdstring

The resource group ID.

rg-*********************
BucketNamestring

The name of the OSS bucket used by the backup vault.

hbr-0005i51******t58
SearchEnabledboolean

Indicates whether the backup search feature is enabled.

true
IndexAvailableboolean

Indicates whether indexes are available. Indexes are available when they are not being updated.

true
BytesDonelong

The amount of data that is backed up. Unit: bytes.

20
Tagsobject []

The tags of the backup vault.

Keystring

The tag key of the backup vault. Valid values of N: 1 to 20.

  • The tag key cannot start with aliyun or acs:.
  • The tag key cannot contain http:// or https://.
  • The tag key cannot be an empty string.
aaa
Valuestring

The tag value of the backup vault. Valid values of N: 1 to 20.

  • The tag value cannot start with aliyun or acs:.
  • The tag value cannot contain http:// or https://.
  • The tag value cannot be an empty string.
a1
SourceTypesarray

The type of the data sources.

string

The type the data source.

ECS_FILE
ReplicationProgressobject

The progress of data synchronization from the backup vault to the mirror vault.

HistoricalReplicationProgressinteger

The progress of historical data synchronization from the backup vault to the mirror vault. Valid values: 0 to 100.

100
NewReplicationProgresslong

The latest synchronization time of incremental data in the mirror vault.

1579413159
BackupPlanStatisticsobject

The statistics of backup plans that use the backup vault.

Oracleinteger

The number of backup plans for Oracle databases.

1
LocalFileinteger

The number of backup plans for on-premises servers.

1
Nasinteger

The number of backup plans for NAS file systems.

1
CommonNasinteger

The number of backup plans for general-purpose NAS file systems.

1
Isiloninteger

The number of backup plans for Isilon storage systems.

1
Ossinteger

The number of backup plans for OSS buckets.

1
SqlServerinteger

The number of backup plans for SQL Server databases.

1
Csginteger

The number of backup plans for cloud storage gateways (CSGs).

1
EcsFileinteger

The number of backup plans for ECS files.

1
MySqlinteger

The number of backup plans for MySQL databases.

1
EcsHanainteger

The number of backup plans for SAP HANA instances.

1
LocalVminteger

The number of backup plans for on-premises virtual machines (VMs).

1
Otsinteger

The number of backup plans for Tablestore instances.

1
TrialInfoobject

The free trial information.

TrialStartTimelong

The start time of the free trial.

1579413159
TrialVaultReleaseTimelong

The time when the free-trial backup vault was released.

1594965600
TrialExpireTimelong

The expiration time of the free trial.

1584597600
KeepAfterTrialExpirationboolean

Indicates whether you are billed based on the pay-as-you-go method after the free trial ends.

true
EncryptTypestring

The encryption type of the backup vault. Valid values:

  • NONE: The backup vault is not encrypted.
  • HBR_PRIVATE (default): The backup vault is encrypted by using HBR-provided keys.
  • KMS: The backup vault is encrypted by using custom Key Management Service (KMS) keys.
HBR_PRIVATE
WormEnabledboolean

Indicates whether the backup locking feature is enabled.

true
SnapshotCountlong

The number of snapshots in the backup vault.

0
CompressionAlgorithmstring

The encryption algorithm used to compress the backup vault. Valid values:

  • DISABLED: The backup vault is not compressed.
  • SNAPPY: The backup vault is compressed by using the SNAPPY encryption algorithm.
  • ZSTD: The backup vault is compressed by using Zstandard, a fast compression algorithm that provides high compression ratios.
ZSTD
RedundancyTypestring

The data redundancy type of the backup vault. Valid values:

  • LRS: Locally redundant storage (LRS) is enabled for the backup vault. Hybrid Backup Recovery (HBR) stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.
  • ZRS: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.
LRS
KmsKeyIdstring

The customer master key (CMK) created in KMS or the alias of the key. This parameter is returned only if EncryptType is set to KMS.

alias/acs/acm
ChargedStorageSizelong

The billable storage usage of the archive vault. Unit: bytes.

1024000
ArchiveStorageSizelong

The billable storage usage at the archive layer. Unit: bytes.

1024000

Examples

Sample success responses

JSONformat

{
  "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": "v-*********************",
        "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
        },
        "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": 0,
        "ReplicationSourceVault": false,
        "ReplicationTargetRegionId": ""
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-01The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-12-06The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-09-06The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-03-29The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.