接口功能介绍

查询云主机备份策略列表
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权

接口约束

1.使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测

URI

GET /v4/ecs/backup-policy/list

路径参数
无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	bb9fdb42056f11eda1610242ac110002
policyID	否	String	云主机备份策略ID，32字节获取：查查询云主机备份策略列表创创建云主机备份策略	26da64d4a77f11ed923d0242ac110007
policyName	否	String	云主机备份策略名称。满足以下规则：只能由数字、英文字母、中划线-、下划线_、点.组成，长度为2-64字符注：在所有资源池不可重复。模糊过滤，存在policyID过滤参数时此参数无效	test-bak
projectID	否	String	企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目	0
pageNo	否	Integer	页码，取值范围：正整数（≥1），注：默认值为1	1
pageSize	否	Integer	每页记录数目，取值范围：[1, 50]，注：默认值为10	10

请求参数

请求头header参数
无

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
error	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
message	String	错误信息的英文描述	SUCCESS
description	String	错误信息的本地化描述（中文）	成功
returnObj	Object	返回对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
currentCount	Integer	当前页记录数目	10
currentPage	Integer	当前页码	1
totalCount	Integer	总记录数	20
totalPage	Integer	总页数	2
policyList	Array of Objects	策略列表		policyList

表 policyList

参数	参数类型	说明	示例	下级对象
regionID	String	资源池ID，您可以调用regionID查看最新的天翼云资源池列表	81f7728662dd11ec810800155d307d5b
status	Integer	是否启用策略，取值范围： 0：停用， 1：启用	1
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	云主机备份保留类型，取值范围： date：按时间保留， num：按数量保留， all：永久保留	num
retentionNum	Integer	只有retentionType为num时返回保留数量值	1
retentionDay	Integer	只有retentionType为date时返回保留天数值	1
resourceCount	Integer	策略已绑定的云主机数量	2
resourceIDs	String	策略已绑定的云主机ID，以逗号分隔	9dda32dc-4180-48cf-8ddf-bb60c61fad22,da7e2058-9dad-4d23-baeb-3d614eec999a
repositoryList	Array of Objects	策略已绑定的云主机备份库列表		repositoryList
projectID	String	企业项目ID	0
totalBackup	Boolean	全量备份，是否开启，取值范围：false（不启用），true（启用）。只有4.0资源池支持开启全量备份	false
advRetentionStatus	Boolean	是否开启高级保留策略，false（不启用），true(启用)。	false
advRetention	Object	高级保留策略内容		advRetention

表 repositoryList

参数	参数类型	说明	示例	下级对象
repositoryID	String	云主机备份库ID	9915c3f4-8d78-445a-a1da-d8d9287d506b
repositoryName	String	云主机备份库名称	test-repo

表 advRetention

参数	参数类型	说明	示例
advDay	Integer	保留n天内、每天的第一个备份，n为输入的数字。单位为天，取值范围：[1, 99999]，默认值0	1
advWeek	Integer	保留n周内、每周的第一个备份，n为输入的数字。单位为周，取值范围：[1, 99999]，默认值0	1
advMonth	Integer	保留n月内、每月的第一个备份，n为输入的数字。单位为月，取值范围：[1, 99999]，默认值0	1
advYear	Integer	保留n年内、每年的第一个备份，n为输入的数字。单位为年，取值范围：[1, 99999]，默认值0	1

枚举参数

无

请求示例

请求url

示例：查询云主机的备份策略的列表GET `.../openapi/v4/ecs/backup-policy/list?regionID=bb9fdb42056f11eda1610242ac110002`

请求头header

无

请求体body

无

响应示例

{
    "returnObj": {
        "currentCount": 1,
        "totalCount": 1,
        "totalPage": 1,
        "policyList": [
            {
                "status": 1,
                "resourceCount": 1,
                "cycleDay": 4,
                "cycleType": "day",
                "policyID": "e14f067ea2d111ed98fd0242ac110007",
                "regionID": "81f7728662dd11ec810800155d307d5b",
                "policyName": "policy-b8b7",
                "retentionType": "date",
                "retentionDay": 90,
                "resourceIDs ": "543074a6-75a0-5e31-2c77-1501e3354f69",
                "time": "12,13,14,15",
                "projectID": "0",
                "repositoryList": [
                    {
                        "repositoryName": "repo-5d90",
                        "repositoryID": "7b9f5848-6a03-497b-8b12-e2ba5f90dc79"
                    }
                ]
            }
        ],
        "currentPage": 1
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码