接口介绍
为用户指定资源池开通云容灾服务(客户端和跨域流量复制),属于region级服务
接口约束
1、用户在该region下未开通过云容灾服务
URI
POST /v4/disaster/open-service-disaster
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 | 参考请求示例 | |
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 成功或失败时的描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 成功或失败时的描述,一般为中文描述 | 参考响应示例 | |
returnObj | 否 | Object | 成功时返回对象 | returnObj 表 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | 参考状态码 | |
error | 否 | String | 业务细分码,为product.module.code三段式大驼峰码 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
masterResourceStatus | 是 | String | 主资源状态 | 参考响应示例 | |
regionID | 是 | String | 资源池ID | 参考响应示例 | |
masterOrderID | 是 | String | 订单ID | 参考响应示例 | |
masterResourceID | 是 | String | 订单资源ID | 参考响应示例 | |
masterOrderNO | 是 | String | 订单编号 | 参考响应示例 | |
resources | 是 | Array of Objects | 订单信息 | 表resources |
表resources
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
orderID | 是 | String | 订单编号 | 参考响应示例 | |
status | 是 | Integer | 订单状态 | 参考响应示例 | |
isMaster | 是 | Boolean | 是否主订单 | 参考响应示例 | |
resourceType | 是 | String | 资源类型,云容灾客户端都为CT_CDR_CLIENT | 参考响应示例 | |
resourceID | 是 | String | 订单资源ID | 参考响应示例 | |
masterOrderID | 是 | String | 订单ID | 参考响应示例 | |
updateTime | 是 | Integer | 更新时间 | 参考响应示例 | |
masterResourceID | 是 | String | 主资源ID | 参考响应示例 | |
itemValue | 是 | Integer | 订单个数 | 参考响应示例 | |
startTime | 是 | Integer | 开始时间 | 参考响应示例 | |
createTime | 是 | Integer | 创建时间 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "604a31163bfb11ee82b50242ac11000c",
"masterResourceID": "4b65909021224618938c33924ff2d2f0",
"masterOrderNO": "20230816140853756057",
"resources": [
{
"orderID": "245e965a91194fc2962bc5edde8993d3",
"status": 2,
"isMaster": true,
"resourceType": "CT_CDR_CLIENT",
"resourceID": "4b65909021224618938c33924ff2d2f0",
"masterOrderID": "604a31163bfb11ee82b50242ac11000c",
"updateTime": 1692166142000,
"masterResourceID": "4b65909021224618938c33924ff2d2f0",
"itemValue": 1,
"startTime": 1692166140000,
"createTime": 1692166135000
},
{
"orderID": "245e965a91194fc2962bc5edde8993d3",
"status": 2,
"isMaster": false,
"resourceType": "CT_CDR_REP_DATA",
"resourceID": "a6221ed5e1d64a51b337bf3183f5b390",
"masterOrderID": "604a31163bfb11ee82b50242ac11000c",
"updateTime": 1692166142000,
"masterResourceID": "4b65909021224618938c33924ff2d2f0",
"itemValue": 1,
"startTime": 1692166140000,
"createTime": 1692166135000
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码