接口功能介绍
该接口提供用户查询云主机快照策略列表的功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
分页查询:当前查询结果以分页形式进行展示,单次查询最多显示50条数据
匹配查找:可以通过部分字段进行匹配筛选数据,无符合条件的为空
接口约束
无
URI
POST /v4/ecs/snapshot-policy/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
pageNo | 否 | Integer | 页码,取值范围:正整数(≥1),注:默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1, 50],注:默认值为10 | 10 | |
snapshotPolicyStatus | 否 | Integer | 快照策略状态,是否启用,取值范围:0(不启用), 1(启用) 注:默认值1(启用) |
0 | |
queryContent | 否 | String | 模糊匹配查询内容(匹配字段:snapshotPolicyID、snapshotPolicyName) | test |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotPolicyID | String | 云主机快照策略ID | 03b2d47aa3ae11eda7ae0242ac110009 | |
snapshotPolicyStatus | Integer | 快照策略状态,是否启用,取值范围:0(不启用), 1(启用) 注:默认值1(启用) |
0 | |
snapshotPolicyName | String | 云主机快照策略名称,满足以下规则:长度为2~63字符,由数字、字母、-组成,只能以字母开头,以数字和字母结尾 | test-123 | |
snapshotTime | String | 快照整点时间,时间取值范围:0~23 注:如果一天内多个时间节点备份,以逗号隔开(如11点15点进行快照,则填写"11,15"),默认值0 |
11,13 | |
retentionType | String | 云主机快照保留类型,取值范围: date(按时间保存), num(按数量保存) |
date | |
retentionDay | String | 云主机快照保留天数,快照保留类型为date时返回,否则为空字符串 | 2 | |
retentionNum | String | 云主机快照保留数量,快照保留类型为num时返回,否则为空字符串 | 3 | |
cycleType | String | 云主机快照周期类型,可选:day(天)、week(周) | day | |
cycleDay | Integer | 周期天数,周期类型为day时返回,表示多少天进行快照 | 10 | |
cycleWeek | String | 周期星期,周期类型为week时返回,表示周几进行快照,由逗号拼接,由0~6组成,0表示周日 | 0 | |
resourceCount | Integer | 绑定云主机数量 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1:指定每页记录数目,查询指定页云主机快照策略列表信息
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"pageNo":1,
"pageSize":2
}
示例2:通过模糊查询关键字为test的云主机快照策略列表
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"queryContent":'test'
}
示例3:通过快照策略状态查询,查询处于启用状态的快照策略
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyStatus": 1
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"snapshotPolicyList": [
{
"snapshotPolicyID": "4f69f096066011ee9caf0242ac110002",
"snapshotPolicyStatus": 0,
"snapshotPolicyName": "test-01",
"snapshotTime": "11,13",
"retentionType": "num",
"retentionDay": "",
"retentionNum": 1,
"cycleType": "day",
"cycleDay": "1",
"cycleWeek": "",
"resourceCount": 0
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码