前置检查
接口描述
本接口用于创建实例组和实例组中添加集群的前置检查。请确保前置检查全部通过后创建多活实例组。
请求结构
POST /v{version}/syncGroup/check HTTP/1.1
Host: redis.bj.baidubce.com
Authorization: authorization string
{
"syncGroupShowId": "syncGroupShowId",
"members": [
{
"memberId": "scs-fsh-ifjmkpkdzceq",
"region": "fsh"
},
{
"memberId": "scs-fsh-luoreupenrtn",
"region": "fsh"
}
]
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 |
类型 |
是否必选 |
参数位置 |
描述 |
version |
String |
是 |
PATH参数 |
API版本号。此处值为2。 |
syncGroupShowId |
String |
否 |
RequestBody参数 |
多活实例组ID。已有的多活实例组中添加集群时必填,新建多活实例组时不需要改参数。 |
members |
List<Member> |
是 |
RequestBody参数 |
需要检查的多活组成员的集群ID。 |
Member
参数名称 |
类型 |
描述 |
memberId |
String |
集群ID。 |
region |
String |
集群所在地域。 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 |
类型 |
描述 |
checkResult |
List |
多活组成员检查结果。 |
connectionResults |
List |
网络连通性检查结果。 |
CheckItem
参数名称 |
类型 |
描述 |
memberId |
String |
实例组成员集群ID。 |
noData |
Boolean |
实例是否无数据。 |
version |
Boolean |
实例引擎类型及版本类型是否支持。 |
engineVersion |
Boolean |
引擎版本是否支持。说明:Redis企业集群版支持4.0和6.0版本。 |
clusterStatus |
Boolean |
网络连通性检查结果。 |
shardNum |
Boolean |
实例分片数是否一致。 |
replicationNum |
Boolean |
实例副本数是否一致。 |
flavor |
Boolean |
实例单分片容量是否一致。 |
notJoined |
Boolean |
实例是否未加入实例组。 |
noSecurityGroup |
Boolean |
实例是否未关联VPC侧安全组。 |
isHitX1 |
Boolean |
集群当前架构是否支持。 |
isAppendOnlyOn |
Boolean |
实例是否开启aof。 |
samePasswd |
Boolean |
实例密码是否一致。 |
ConnectionItem
参数名称 |
类型 |
描述 |
sourceId |
String |
源实例ID。 |
targetId |
String |
目标实例ID。 |
connectable |
Boolean |
源端到目标端的连通性是否正常。 |
请求示例
POST http://redis.fsh.baidubce.com/v2/syncGroup/check
Host: redis.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"members": [
{
"memberId": "scs-fsh-ifjmkpkdzceq",
"region": "fsh"
},
{
"memberId": "scs-fsh-luoreupenrtn",
"region": "fsh"
}
]
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"checkResult": [
{
"memberId": "scs-fsh-ifjmkpkdzceq",
"noData": true,
"version": true,
"engineVersion": true,
"clusterStatus": true,
"shardNum": false,
"replicationNum": true,
"flavor": true,
"notJoined": true,
"noSecurityGroup": true,
"isHitX1": true,
"isAppendOnlyOn": true,
"samePasswd": true
},
{
"memberId": "scs-fsh-luoreupenrtn",
"noData": true,
"version": true,
"engineVersion": true,
"clusterStatus": true,
"shardNum": false,
"replicationNum": true,
"flavor": true,
"notJoined": true,
"noSecurityGroup": true,
"isHitX1": true,
"isAppendOnlyOn": true,
"samePasswd": true
}
],
"connectionResults": [
{
"sourceId": "scs-fsh-ifjmkpkdzceq",
"targetId": "scs-fsh-luoreupenrtn",
"connectable": true
},
{
"sourceId": "scs-fsh-luoreupenrtn",
"targetId": "scs-fsh-ifjmkpkdzceq",
"connectable": true
}
]
}