接口功能介绍
查询云硬盘备份策略列表。
当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
接口约束
无
URI
GET /v4/ebs-backup/policy/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
pageNo | 否 | Integer | 页码,默认值1 | 1 | |
pageSize | 否 | Integer | 每页记录数目 ,默认10 | 10 | |
policyID | 否 | String | 备份策略ID | d15e7d402f8f11ed81370242ac110006 | |
policyName | 否 | String | 备份策略名,指定了policyID时,该参数会被忽略 | test-policy | |
projectID | 否 | String | 企业项目ID,默认“0” | 0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | 是 | String | 错误信息的英文描述 | SUCCESS | |
description | 是 | String | 错误信息的本地化描述(中文) | 成功 | |
returnObj | 否 | Object | 成功时返回对象 | returnObj | |
errorCode | 否 | String | 业务错误细分码,发生错误时返回 | 参考错误码 |
表 returnObj
参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
policyList | 是 | Array | 策略列表 | policyList | |
totalCount | 是 | Integer | 策略总数 | 20 | |
currentCount | 是 | Integer | 当前页策略数 | 10 |
表 policyList
参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
accountID | 是 | String | 账户ID | 562b89493b1a40e1b97ea05e50dd8170 | |
status | 是 | Integer | 状态,0-停用,1-启用 | 1 | |
createdDate | 是 | Integer | 创建时间 | 663136607 | |
policyID | 是 | String | 策略ID | d15e7d402f8f11ed81370242ac110006 | |
policyName | 是 | String | 策略名 | test-policy | |
cycleType | 是 | String | 备份周期类型,day-按天备份,week-按星期备份 | day | |
cycleDay | 否 | Integer | 备份周期,只有cycleType为day时返回 | 1 | |
cycleWeek | 否 | String | 备份周期,只有cycleType为week时返回,则取值范围0-6代表星期日-星期六,如果一周有多天备份,以逗号隔开 | 0,2,6 | |
time | 是 | String | 备份整点时间,取值范围0-23,如果一天内多个时间节点备份,以逗号隔开 | 1,20 | |
retentionType | 是 | String | 备份保留类型,num-按数量保留,date-按时间保留,all-全部保留 | num | |
retentionNum | 否 | Integer | 保留数量,只有retentionType为num时返回 | 1 | |
retentionDay | 否 | Integer | 保留天数,只有retentionType为date时返回 | 1 | |
remainFirstOfCurMonth | 否 | Boolean | 是否保留每个月第一个备份,在retentionType为num时返回 | false | |
resourceCount | 是 | Integer | 策略绑定的云硬盘数量 | 2 | |
resourceIDs | 是 | String | 策略绑定的云硬盘ID,以逗号分隔 | 9dda32dc-4180-48cf-8ddf-bb60c61fad22,da7e2058-9dad-4d23-baeb-3d614eec999a | |
repositoryList | 是 | Array | 策略绑定的云硬盘备份存储库列表 | repositoryList | |
projectID | 是 | String | 企业项目ID | 0 |
表 repositoryList
参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
repositoryID | 是 | String | 云硬盘备份存储库ID | 9915c3f4-8d78-445a-a1da-d8d9287d506b | |
repositoryName | 是 | String | 云硬盘备份存储库名 | test-repo |
请求示例
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"policyList": [
{
"status": 0,
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceCount": 2,
"resourceIDs": "4abf5a9e-271c-4b15-bdee-c4187fbe4531,697220b9-a4c7-40f8-819d-c19c4134348c",
"retentionNum": 6,
"cycleType": "week",
"policyID": "39130dde4b9211eda8e60242ac110002",
"cycleWeek": "0",
"policyName": "week-sunday",
"remainFirstOfCurMonth": false,
"createDate": 1665761491,
"retentionType": "num",
"time": "1,12",
"repositoryList": [
{
"repositoryName": "test-repo",
"repositoryID": "9915c3f4-8d78-445a-a1da-d8d9287d506b"
}
],
"accountID": "552b89493b1a40e1b97ea05e50dd8170",
"projectID": "0"
}
],
"totalCount": 5,
"currentCount": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
errorCode | 描述 |
---|---|
EbsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
EbsBackup.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
EbsBackup.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
EbsBackup.Parameter.InvalidPageParams | 请求参数错误:{错误原因} |
EbsBackup.Parameter.InvalidPolicyID | 请求参数错误:{错误原因} |
EbsBackup.Parameter.InvalidRegionID | 请求参数错误:{错误原因} |
EbsBackup.OrderCheck.InvalidProjectID | 企业项目不存在,请确认企业项目ID是否有效 |