Call DescribeVaults to query the backup vault list.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Below are the unique request parameters for this API and some common parameters. For more information, see Common Parameters.

Action string required Sample value: DescribeVaults

Action required, possible values: DescribeVaults.

Version string required Sample value: 2024-03-01

API version, value: 2024-03-01.

TagFilters object[] Optional Sample value: --

Tag.

Key string required

Multiple Keys use "AND" logic.

Values string[] required

Multiple values for the same key have an "or" relationship.

PageNumber integer Optional Example value: 1

Page number. The default value is 1.

PageSize integer Optional Sample value: 10

Number of entries per page. Default is 10.

ProjectName string Optional Example: myproject

Retrieve the backup vault under the specified project. If not specified, retrieve all backup vaults.

Filters object Optional Sample value: --

Backup vault filter criteria.

VaultId string Optional Example: vault-bhkpuiktd7m5krcf****

Backup vault ID.

VaultName string Optional Example value: my-vault

Name of the backup vault.

Response parameters

Below are the unique response parameters for this API. For more information, refer to Response Structure.

Total integer Sample value: 1

Total number of backup vaults that meet the criteria.

VaultList object[] Sample value: --

Backup vault list.

VaultId string Example value: vault-xxxxx

Backup vault ID.

Endpoint string Example value: tos-cn-shanghai.ivolces.com

Access domain name.

Region string Sample value: cn-shanghai

The region where the backup vault is located.

VaultName string Example value: my-vault

Name of the backup vault.

ProjectName string Example value: my-project

Project name.

CreateAt string Example value: 2025-05-22T18:02:04+08:00

Creation Time.

Tags object[] Example value: --

Tag array.

Key string Sample value: my-key

Tag key.

Value string Example value: my-value

Tag value.

Sample request

Sample response

Error code

The table below lists error codes related to this API and business logic. For public error codes, please refer to the public error code documentation.

Status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Internal error.

Cloud Backup and Recovery