开通云备份服务
更新时间 2026-04-02 15:11:36
最近更新时间: 2026-04-02 15:11:36
接口功能介绍
为用户指定资源池开通云备份服务(客户端和跨域流量复制),属于region级服务
接口约束
1、用户在该region下未开通过云备份服务
URI
POST /v4/backup/open-service-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | backup-test |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
| message | String | 成功或失败时的描述,一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述,一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj | |
| errorCode | String | 业务细分码,为product.module.code三段式码。 | backup.regionInfo.empty | |
| error | String | 业务细分码,为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后,在若干错误情况下,可以使用masterOrderID进一步确认订单状态及资源状态 | 参考响应示例 | |
| masterResourceStatus | String | 主资源状态。只有主订单资源会返回 | 参考响应示例 | |
| regionID | String | 资源所属资源池ID | 参考响应示例 | |
| resources | Array of Objects | 资源明细列表 | resources |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| orderID | String | 订单编号 | fbd15e68fd6a49fb87286d17aa802b44 | |
| status | String | 订单状态 | 1 | |
| isMaster | Boolean | 是否主订单 | true | |
| resourceType | String | 资源类型 | CT_CBR_REP_DATA | |
| resourceID | String | 订单资源ID | 321b3924fd0f47959b838e3751c48ca9 | |
| masterOrderID | String | 订单ID | 183ddd74959b11ee92e70242ac110003 | |
| updateTime | Integer | 更新时间 | 1678436086000 | |
| masterResourceID | String | 主资源ID | b3748dbdc659418c9b74051657982a14 | |
| itemValue | Integer | 订单个数 | 2 | |
| startTime | Integer | 开始时间 | 1678436082000 | |
| createTime | Integer | 创建时间 | 1678436064000 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "backup-test",
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"masterResourceStatus": "started",
"regionID": "200000002368",
"masterOrderID": "183ddd74959b11ee92e70242ac110003",
"masterResourceID": "b3748dbdc659418c9b74051657982a14",
"masterOrderNO": null,
"resources": [
{
"orderID": "fbd15e68fd6a49fb87286d17aa802b44",
"status": 2,
"isMaster": true,
"resourceType": "CT_CBR_CLIENT",
"resourceID": "b3748dbdc659418c9b74051657982a14",
"masterOrderID": "183ddd74959b11ee92e70242ac110003",
"updateTime": 1702020400000,
"masterResourceID": "b3748dbdc659418c9b74051657982a14",
"itemValue": 1,
"startTime": 1702020396000,
"resourceConfig": {
"platformid": "200000002368",
"projectID": "0",
"regionid": "200000002368",
"prodissupportedcredit": "PUB_100_02_0001",
"value": "1",
"zoneid": "200000002368",
"adminUrl": "http://proxy.openapi.cn:11804/",
"version": "v1",
"billmode": "2",
"versionCode": "ct.cbr.ecs.client",
"zonetype": "openstack",
"isadaptation": "ORD_100_06_0002",
"type": "ecs_client"
},
"createTime": 1702020387000
},
{
"orderID": "fbd15e68fd6a49fb87286d17aa802b44",
"status": 2,
"isMaster": false,
"resourceType": "CT_CBR_REP_DATA",
"resourceID": "321b3924fd0f47959b838e3751c48ca9",
"masterOrderID": "183ddd74959b11ee92e70242ac110003",
"updateTime": 1702020400000,
"masterResourceID": "b3748dbdc659418c9b74051657982a14",
"itemValue": 1,
"startTime": 1702020396000,
"resourceConfig": {
"version": "v1",
"platformid": "200000002368",
"projectID": "0",
"regionid": "200000002368",
"prodissupportedcredit": "PUB_100_02_0001",
"value": "1",
"zoneid": "200000002368",
"adminUrl": "http://proxy.openapi.cn:11804/",
"serviceid": "c2c888d5-ae20-42e4-85bd-e54248b510ee",
"billmode": "2",
"versionCode": "ct.cbr.rep.data",
"zonetype": "openstack",
"type": "standard"
},
"createTime": 1702020387000
}
]
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码