获取一个或者多个符合条件的备份计划。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hbr:DescribeBackupPlans | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 否 | 分页页码，从 1 开始，默认值为 1。 | 1 |
| PageSize | integer | 否 | 分页大小，最小值为 1，最大值为 99，默认值为 10。 | 10 |
| SourceType | string | 是 | 数据源类型，取值范围：
| ECS_FILE |
| Filters | array<object> | 否 | 查询过滤器。 | |
| object | 否 | |||
| Key | string | 否 | 查询过滤器中的键值。取值可包括：
| vaultId |
| Values | array | 否 | 查询过滤器中的待匹配的值。 | |
| string | 否 | 查询过滤器中的待匹配的值。 | v-********************* |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 8,
"BackupPlans": {
"BackupPlan": [
{
"VaultId": "v-*********************",
"BackupType": "COMPLETE",
"CreateTime": 1554347313,
"DataSourceId": "ds-000ht6o9*****w61",
"SourceType": "ECS_FILE",
"Disabled": false,
"Prefix": "oss-prefix",
"Options": "{\"UseVSS\":false}",
"ClientId": "c-000ge4w*****1qb",
"Exclude": "[\"/var\", \"/proc\"]\t",
"Retention": 7,
"CreatedTime": 1554347313,
"ClusterId": "cl-000ht6o9******h",
"Bucket": "hbr-backup-oss",
"Detail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
"Schedule": "I|1602673264|P1D",
"SpeedLimit": "0:24:5120",
"InstanceId": "i-*********************",
"PlanId": "plan-*********************",
"BackupSourceGroupId": "System-Database",
"FileSystemId": "00594",
"OtsDetail": {
"TableNames": {
"TableName": [
"test2_HBR_RESTORED"
]
}
},
"InstanceName": "instancename",
"UpdatedTime": 1554347313,
"PlanName": "planname",
"Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
"Rules": {
"Rule": [
{
"DestinationRetention": 90,
"Schedule": "I|1631685600|P1D",
"Retention": 90,
"Disabled": true,
"DoCopy": false,
"DestinationRegionId": "cn-shanghai",
"RuleId": "rule-0008i52rf0ulpni6kn6m",
"RuleName": "Disk Golden Rule",
"BackupType": "COMPLETE"
}
]
},
"Resources": {
"Resource": [
{
"SourceType": "UDM_DISK",
"ResourceId": "d-j6cgioir6m******lu4",
"Extra": "{\\\"doBackup\\\":false,\\\"diskName\\\":\\\"data_disk\\\",\\\"size\\\":100,\\\"type\\\":\\\"data\\\",\\\"category\\\":\\\"cloud_essd\\\",\\\"imageId\\\":\\\"\\\",\\\"device\\\":\\\"/dev/xvdb\\\",\\\"encrypted\\\":false}"
}
]
},
"Paths": {
"Path": [
"[\"/home\"]"
]
},
"TrialInfo": {
"TrialStartTime": 1579413159,
"TrialVaultReleaseTime": 1594965600,
"TrialExpireTime": 1584597600,
"KeepAfterTrialExpiration": true
},
"InstanceGroupId": "i-**",
"CrossAccountType": "CROSS_ACCOUNT",
"CrossAccountUserId": 0,
"CrossAccountRoleName": "BackupRole",
"KeepLatestSnapshots": 0,
"DestSourceType": "OSS",
"DestDataSourceId": "ds-*********************",
"DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
"ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
"LatestExecuteJobId": "job-12345678"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-08 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-07-31 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-02-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |