Call DescribeVaults to query the backup vault list. ## Debugging [去调试](https://api.volcengine.com/api-explorer/?action=DescribeVaults&groupName=%E5%A4%87%E4%BB%BD%E5%BA%93&serviceCode=cbr&version=2024-03-01) ## Request parameters Below are the unique request parameters for this API and some common parameters. For more information, see [Common Parameters](https://www.volcengine.com/docs/6369/67268). **Action** string 必选 `Sample value: DescribeVaults` Action required, possible values: DescribeVaults. **Version** string 必选 `Sample value: 2024-03-01` API version, value: 2024\-03\-01. **TagFilters** object[] `Optional` `Sample value: --` Tag. **Key** string 必选 Multiple Keys use "AND" logic. **Values** string[] 必选 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](https://www.volcengine.com/docs/6369/80336). **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 ```JSON POST /?Action=DescribeVaults&Version=2024-03-01 HTTP/1.1 Host: cbr.cn-beijing.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20251011T091425Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251011/cn-beijing/cbr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f {} ``` ## Sample response ```json { "ResponseMetadata": { "RequestId": "202510271449311540291****EDE503", "Action": "DescribeVaults", "Version": "2024-03-01", "Service": "cbr", "Region": "cn-beijing" }, "Result": { "Total": 1, "VaultList": [ { "VaultId": "vault-kvu6yr5rq6b2v5zc****", "Endpoint": "tos-cn-shanghai.ivolces.com", "Region": "cn-shanghai", "VaultName": "my-vault", "ProjectName": "my-project", "CreateAt": "2025-05-22T18:02:04+08:00", "Tags": [ { "Key": "my-key", "Value": "my-value" } ] } ] } } ``` ## 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](https://www.volcengine.com/docs/6369/68677) 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