开通云备份服务
更新时间 2023-10-12 15:22:32
最近更新时间: 2023-10-12 15:22:32
开通云备份服务API说明
接口介绍
为用户指定资源池开通云备份服务(客户端和跨域流量复制)，属于region级服务
接口约束
1、用户在该region下未开通过云备份服务
URI
POST /v4/backup/open-service-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 | 参考请求示例 | |
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为处理中/失败，详见errorCode) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考returnObj表 | 参考returnObj表 | |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码。 | 参考状态码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 是 | String | 订单ID | 参考响应示例 | |
| masterResourceStatus | 是 | String | 主资源状态。只有主订单资源会返回 | 参考响应示例 | |
| regionID | 是 | String | 资源所属资源池ID | 参考响应示例 | |
| resources | 是 | Array of Objects | 资源明细列表 | 参考表resources |
表 resources
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| orderID | 是 | String | 订单编号 | 参考响应示例 | |
| status | 是 | String | 订单状态 | 参考响应示例 | |
| isMaster | 是 | String | 是否主订单 | 参考响应示例 | |
| resourceType | 是 | String | 资源类型，云备份客户端都为CT_CBR_CLIENT | 参考响应示例 | |
| resourceID | 是 | String | 订单资源ID | 参考响应示例 | |
| masterOrderID | 是 | String | 订单ID | 参考响应示例 | |
| updateTime | 是 | Integer | 更新时间 | 参考响应示例 | |
| masterResourceID | 是 | String | 主资源ID | 参考响应示例 | |
| itemValue | 是 | Integer | 订单个数 | 参考响应示例 | |
| startTime | 是 | Integer | 开始时间 | 参考响应示例 | |
| createTime | 是 | Integer | 创建时间 | 参考响应示例 |
表 errorDetail
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bssErrCode | 是 | String | bss错误明细码，包含于bss格式化JSON错误信息中 | 参考状态码 | |
| bssErrMsg | 是 | String | bss错误信息，包含于bss格式化JSON错误信息中 | 参考状态码 | |
| bssOrigErr | 是 | String | 无法明确解码bss错误信息时，原样透出的bss错误信息 | 参考状态码 | |
| bssErrPrefixHint | 是 | String | bss格式化JSON错误信息的前置提示信息 | 参考状态码 |
请求示例
请求头header
无
请求体body
{
"regionID": "20230211ebsspec7",
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "8fbcfdaabf1b11edb8e70242ac11000f",
"masterResourceID": "b846f31091124624b7a25b6102ceb6f5",
"masterOrderNO": null,
"resources": [
{
"orderID": "cab25c1c0ca747e7a37d45a03efad013",
"status": 2,
"isMaster": true,
"resourceType": "CT_CBR_CLIENT",
"resourceID": "b846f31091124624b7a25b6102ceb6f5",
"masterOrderID": "8fbcfdaabf1b11edb8e70242ac11000f",
"updateTime": 1678436086000,
"masterResourceID": "b846f31091124624b7a25b6102ceb6f5",
"itemValue": 1,
"startTime": 1678436082000,
"createTime": 1678436064000
},
{
"orderID": "cab25c1c0ca747e7a37d45a03efad013",
"status": 2,
"isMaster": false,
"resourceType": "CT_CBR_REP_DATA",
"resourceID": "9383b3c804d04b4aaadd41b2a52799d8",
"masterOrderID": "8fbcfdaabf1b11edb8e70242ac11000f",
"updateTime": 1678436086000,
"masterResourceID": "b846f31091124624b7a25b6102ceb6f5",
"itemValue": 1,
"startTime": 1678436082000,
"createTime": 1678436064000
}]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
错误码
请参考状态码
