Call DescribeBackupPolicies to query backup policies. ## Debugging [去调试](https://api.volcengine.com/api-explorer/?action=DescribeBackupPolicies&groupName=%E5%A4%87%E4%BB%BD%E7%AD%96%E7%95%A5&serviceCode=cbr&version=2024-03-01) ## Request parameters Below are only the request parameters specific to this API and some common parameters For more information, see [Common parameters](https://www.volcengine.com/docs/6369/67268). **Action** string 必选 `Example value: DescribeBackupPolicies` Operation to perform: DescribeBackupPolicies. **Version** string 必选 `Example value: 2024-03-01` API version, value: 2024\-03\-01. **PageNumber** integer `Optional` `Sample value: 1` Page number, defaults to 1. **PageSize** integer `Optional` `Sample Value: 10` Number of records per page. The default is 10. **Filters** object `Optional` `Example value: ---` Backup policy filter criteria. **Name** string `Optional` `Example value: my-policy` Backup policy name. **EnablePolicy** boolean `Optional` `Example value: true` Enable the policy. **PolicyId** string `Optional` `Example value: policy-xxxxx` Backup policy ID. ## Response parameters Below are only the response parameters specific to this API For more information, see [Response structure](https://www.volcengine.com/docs/6369/80336). **Total** integer `Example value: 10` Total number of backup policies that meet the criteria. **BackupPolicies** object[] `Sample value: --` Backup policy list. **PolicyId** string `Sample Value: policy-kvu72awx9f8r2l0k****` Backup policy ID. **PlanNumber** integer `Sample Value: 3` The number of backup plans associated with this policy. **CreatedAt** string `Sample value: 2025-05-22T18:02:04+08:00` Creation Time. **UpdatedAt** string `Sample value: 2025-05-22T18:02:04+08:00` Update time. **AccountId** string `Example: 200000****` ID of the account that created this policy. **Name** string `Example: my-policy` Policy name. **EnablePolicy** boolean `Example value: true` Whether to enable the policy. Description as follows: * true: Enable policy. * false: Disable policy. **Crontab** string `Sample value: 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` Used to specify the backup schedule. Supports standard crontab expression configuration. **BackupType** string `Example value: FULL` Backup type. Available values are as follows: * FULL: Full backup. * INCREMENTAL: Incremental backup. **RetentionDay** integer `Sample Value: 3` Retention time for recovery points. \-1 indicates retention is permanent. ## Sample request ```JSON POST /?Action=DescribeBackupPolicies&Version=2024-03-01 HTTP/1.1 Host: cbr.cn-beijing.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20251013T034845Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251013/cn-beijing/cbr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f {} ``` ## Sample response ```json { "ResponseMetadata": { "RequestId": "20251030180009167***064CA4EE1", "Action": "DescribeBackupPolicies", "Version": "2024-03-01", "Service": "cbr", "Region": "cn-beijing" }, "Result": { "Total": 10, "BackupPolicies": [ { "PolicyId": "policy-kvu72awx9f8r2l0k****", "PlanNumber": 3, "CreatedAt": "2025-05-22T18:02:04+08:00", "UpdatedAt": "2025-05-22T18:02:04+08:00", "AccountId": "200000****", "Name": "my-policy", "EnablePolicy": true, "Crontab": "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", "BackupType": "FULL", "RetentionDay": 3 } ] } } ``` ## Error code The table below lists the error codes related to this interface and its business logic. For public error codes, see the [Public Error Code](https://www.volcengine.com/docs/6369/68677) documentation. |Status code |Error code |Error message |Description | |---|---|---|---| |400 |InvalidParameter |The specified parameter %s is not valid. |The parameter value is invalid. | |500 |InternalError |The request processing has failed due to some unknown error, exception or failure. |Internal error. |

Cloud Backup and Recovery