文档中心

云备份

备份计划

DescribeBackupPlans - 查询备份计划

DescribeBackupPlans - 查询备份计划

调用 DescribeBackupPlans 查询备份计划。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeBackupPlans

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

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

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

PageNumber integer 可选示例值：1

页码，默认为1。

PageSize integer 可选示例值：10

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

Filters object 可选示例值：--

备份计划过滤条件。

PlanId string 可选示例值：plan-xxxxxxxx

备份计划 ID

Name string 可选示例值：my-plan

备份计划名称

返回参数

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

Total integer 示例值：10

符合条件的备份计划总数。

Plans object[] 示例值：--

备份计划列表。

PlanId string 示例值：plan-xxxx

备份计划 ID

Name string 示例值：my-plan

备份计划名称

AccountId string 示例值：2xxxxxxx

创建此策略的账户 ID

Policy object

备份策略

PolicyId string 示例值：policy-kvu72awx9f8r2l0k****

备份策略 ID。

PlanNumber integer 示例值：3

该策略已关联的备份计划数量。

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

创建时间。

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

更新时间。

AccountId string 示例值：200000****

创建此策略的账户 ID。

Name string 示例值：my-policy

策略名称。

EnablePolicy boolean 示例值：true

是否启用策略，取值说明如下：

true：启用策略。

false：禁用策略。

Crontab string 示例值：0 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 * * 0,1,2,3,4,5,6

用于指定备份周期，支持标准 crontab 表达式配置。

BackupType string 示例值：FULL

备份类型，取值说明如下：

FULL：全量备份。

INCREMENTAL：增量备份。

RetentionDay integer 示例值：3

恢复点保留时间，-1 表示持续保留。

CreatedAt string 示例值：2025-02-06T16:54:22+08:00

创建时间

UpdatedAt string 示例值：2025-02-06T16:54:22+08:00

更新时间

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数值无效。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。

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

这个页面对您有帮助吗？

有用

有用

无用

无用