文档中心

云备份

备份库

DescribeVaults - 查询备份库

DescribeVaults - 查询备份库

调用 DescribeVaults 查询备份库列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeVaults

要执行的操作，取值：DescribeVaults。

Version string 必选示例值：2024-03-01

API的版本，取值：2024-03-01。

TagFilters object[] 可选示例值：--

标签。

Key string 必选

多个Key为"与"关系

Values string[] 必选

同一个Key的多个Value为"或"关系

PageNumber integer 可选示例值：1

页码。默认为1。

PageSize integer 可选示例值：10

每页数据条数。默认为10。

ProjectName string 可选示例值：myproject

获取指定项目下的备份库。如果未指定，则获取所有的备份库。

Filters object 可选示例值：--

备份库过滤条件。

VaultId string 可选示例值：vault-bhkpuiktd7m5krcf****

备份库 ID。

VaultName string 可选示例值：my-vault

备份库名称。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total integer 示例值：1

符合条件的备份库总数。

VaultList object[] 示例值：--

备份库列表。

VaultId string 示例值：vault-xxxxx

备份库 ID。

Endpoint string 示例值：tos-cn-shanghai.ivolces.com

访问域名。

Region string 示例值：cn-shanghai

备份库所在的地域。

VaultName string 示例值：my-vault

备份库名称。

ProjectName string 示例值：my-project

项目名称。

CreateAt string 示例值：2025-05-22T18:02:04+08:00

创建时间。

Tags object[] 示例值：--

标签数组。

Key string 示例值：my-key

标签的键。

Value string 示例值：my-value

标签的值。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。

最近更新时间：2025.10.31 18:11:02

这个页面对您有帮助吗？

有用

有用

无用

无用