接口功能介绍
该接口备份策略绑定云主机
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权: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资源池进行公测
2.备份策略与云主机处于相同的企业项目下,才可进行绑定
3.云主机备份策略可绑定的云主机有配额限制,请在配额限制范围内绑定
4.云主机存在且状态为运行中或关机,不可重复绑定
URI
POST /v4/ecs/backup-policy/bind-instances
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
policyID | 是 | String | 云主机备份策略ID,32字节 获取: 查 查询云主机备份策略列表 创 创建云主机备份策略 |
e14f067ea2d111ed98fd0242ac110007 | |
instanceIDList | 是 | String | 云主机ID列表,多台使用英文逗号分割,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policyID | String | 云主机备份策略ID | a2e8c1368b3911ed915f0242ac11000c | |
instanceIDList | String | 一台或多台云主机ID,多台则使用英文逗号分割 | 73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:备份策略绑定两台云主机,云主机按照备份策略的制定去完成备份任务
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"instanceIDList":"73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026",
"policyID":"e14f067ea2d111ed98fd0242ac110007"
}
响应示例
{
"returnObj": {
"instanceIDList":"73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026",
"policyID":"e14f067ea2d111ed98fd0242ac110007"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码