接口介绍
通过接口根据用户输入的保护组ID,云主机ID,配置容灾云主机名称、规格、IP地址、硬盘类型、恢复点、弹性IP,执行故障切换,启用容灾中心 可用区内的云主机,以确保业务正常运行
接口约束
1、云主机存在保护组中
2、云容灾保护组存在
3、容灾云主机名称限制,请参考弹性云主机的相关限制防止资源创建失败
4、硬盘类型:故障切换磁盘类型需要与启动复制时容灾磁盘类型的选择进行关联:如果容灾磁盘类型选择普通IO或者高IO,则此处可选项为普通IO和高IO,如果容灾磁盘类型选择通用SSD或者超高IO,则此处可选项为通用SSD或超高IO
URI
POST /v4/disaster/start-failover-disaster
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
pairID | 是 | String | 保护组ID | 参考请求示例 | |
ecsID | 是 | String | 云主机ID | 参考请求示例 | |
instanceName | 是 | String | 故障切换云主机名称 | 参考请求示例 | |
favorID | 是 | String | 容灾机器规格ID(查询弹性云主机规格管理接口获取) | 参考请求示例 | |
volumeType | 是 | String | 磁盘类型 | 参考状态枚举表 | |
restoreID | 是 | String | 恢复点ID | 参考请求示例 | |
publicIpID | 否 | String | 弹性ipID(查询网络的弹性IP的接口获取) | 参考请求示例 | |
FailoverIp | 否 | String | 故障切换ip(默认0.0.0.0) | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 成功或失败时的描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 成功或失败时的描述,一般为中文描述 | 参考响应示例 | |
returnObj | 否 | Object | 成功时返回对象 | returnObj 表 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | 参考状态码 | |
error | 否 | String | 业务细分码,为product.module.code三段式大驼峰码 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
status | 是 | String | 云容灾故障切换操作下发成功 | 参考响应示例 | |
msg | 是 | String | 云容灾故障切换操作下发成功描述 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"pairID": "88c715b0-2f95-4aa6-b6dd-d81a033e2566",
"ecsID":"48f9c789-b142-8c6e-8ac2-90741ad14fcd",
"instanceName": "drill-test01",
"favorID":"24ac7dad-3e8e-acc1-2b3f-297623d793bd",
"volumeType": "SATA",
"restoreID": "e2c7f2ca-578c-11ee-bc48-fa163e5f3a5d",
"publicIpID": "eip-200ebcg",
"FailoverIp":"0.0.0.0"
}
响应示例
{
"returnObj": {
"status": "success",
"msg": "Disaster failover started successfully."
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码