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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVaults

The operation that you want to perform. Set the value to DescribeVaults.

VaultId String No v-*********************

The ID of the backup vault.

VaultRegionId String No cn-shanghai

The ID of the region where the backup vault resides.

Status String No CREATED

The status of the backup vault. Vaild 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.
PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

VaultType String No STANDARD

The type of the backup vault. Valid value: STANDARD: common backup vault

Tag.N.Key String No TestKey

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 key cannot be an empty string.
Tag.N.Value String No TestValue

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

  • The value cannot start with aliyun or acs:.
  • The value cannot contain http:// or https:// .
  • The value cannot be an empty string.
ResourceGroupId String No rg-*********************

The ID of the resource group in which you want to query instances.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. The status code 200 indicates that the request is successful.

Message String successful

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
TotalCount Integer 8

The total number of backup vaults that are returned.

Vaults Array of Vault

The backup vaults.

Vault
BytesDone Long 20

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

CreatedTime Long 1554347313

The time when the backup vault was created. The time follows the UNIX time format. Unit: seconds.

Description String vault description

The description of the backup vault.

LatestReplicationTime Long 1554347313

The time when the last remote backup is synchronized. The time follows the UNIX time format. Unit: seconds.

Replication Boolean false

Indicates whether the backup vault resides in a different region from the data source.

  • true: remote backup vault
  • false: local backup vault
ReplicationSourceRegionId String v-*********************

The ID of the region where the remote backup vault resides.

ReplicationSourceVaultId String v-*********************

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

ResourceGroupId String rg-*********************

The ID of the resource group.

Status String CREATED

The status of the backup vault.

  • UNKNOWN: The backup vault is in an unknown state.
  • INITIALIZING: The backup vault is being initialized.
  • CREATED: The backup vault is created.
  • ERROR: The backup vault fails to be accessed.
StorageSize Long 10

The usage of the backup vault. Unit: bytes.

Tags Array of Tag

The tags of the backup vault.

Tag
Key String aaa

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.
Value String a1

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.
UpdatedTime Long 1554347313

The time when the backup vault was updated. The time follows the UNIX time format. Unit: seconds.

VaultId String v-*********************

The ID of the backup vault.

VaultName String vaultname

The name of the backup vault.

VaultRegionId String cn-shanghai

The ID of the region where the backup vault resides.

VaultStatusMessage String SOURCE_VAULT_ALREADY_HAS_REPLICATION

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

  • UNKNOWN_ERROR: indicates that an unknown error occurs.
  • SOURCE_VAULT_ALREADY_HAS_REPLICATION : indicates that an image repository is specified for the source vault.
VaultStorageClass String STANDARD

The storage type of the backup vault. Valid value: STANDARD: standard storage

VaultType String STANDARD

The type of the backup vault. Valid value: STANDARD: common backup vault

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVaults
&<Common request parameters>

Sample success responses

XML format

<DescribeVaultsResponse>
  <TotalCount>8</TotalCount>
  <PageSize>10</PageSize>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <PageNumber>1</PageNumber>
  <Code>200</Code>
  <Success>true</Success>
  <Vaults>
        <Vault>
              <Status>CREATED</Status>
              <Description>vault description</Description>
              <CreatedTime>1554347313</CreatedTime>
              <ResourceGroupId>rg-*********************</ResourceGroupId>
              <VaultName>vaultname</VaultName>
              <VaultStorageClass>STANDARD</VaultStorageClass>
              <ReplicationSourceRegionId>v-*********************</ReplicationSourceRegionId>
              <StorageSize>10</StorageSize>
              <ReplicationSourceVaultId>v-*********************</ReplicationSourceVaultId>
              <VaultId>v-*********************</VaultId>
              <VaultRegionId>cn-shanghai</VaultRegionId>
              <VaultType>STANDARD</VaultType>
              <VaultStatusMessage>SOURCE_VAULT_ALREADY_HAS_REPLICATION</VaultStatusMessage>
              <LatestReplicationTime>1554347313</LatestReplicationTime>
              <Replication>false</Replication>
              <BytesDone>20</BytesDone>
              <UpdatedTime>1554347313</UpdatedTime>
              <Tags>
                    <Tag>
                          <Value>a1</Value>
                          <Key>aaa</Key>
                    </Tag>
              </Tags>
        </Vault>
  </Vaults>
</DescribeVaultsResponse>

JSON format

{
    "TotalCount": 8,
    "PageSize": 10,
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "PageNumber": 1,
    "Code": 200,
    "Success": true,
    "Vaults": {
        "Vault": {
            "Status": "CREATED",
            "Description": "vault description",
            "CreatedTime": 1554347313,
            "ResourceGroupId": "rg-*********************",
            "VaultName": "vaultname",
            "VaultStorageClass": "STANDARD",
            "ReplicationSourceRegionId": "v-*********************",
            "StorageSize": 10,
            "ReplicationSourceVaultId": "v-*********************",
            "VaultId": "v-*********************",
            "VaultRegionId": "cn-shanghai",
            "VaultType": "STANDARD",
            "VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
            "LatestReplicationTime": 1554347313,
            "Replication": false,
            "BytesDone": 20,
            "UpdatedTime": 1554347313,
            "Tags": {
                "Tag": {
                    "Value": "a1",
                    "Key": "aaa"
                }
            }
        }
    }
}

Error codes

For a list of error codes, visit the API Error Center.