前置检查
更新时间：2023-09-21
前置检查
接口描述
本接口用于创建实例组和实例组中添加集群的前置检查。请确保前置检查全部通过后创建多活实例组。
请求结构
Plain Text
1POST /v{version}/syncGroup/check HTTP/1.1
2Host: redis.bj.baidubce.com
3Authorization: authorization string
4{
5 "syncGroupShowId": "syncGroupShowId",
6 "members": [
7 {
8 "memberId": "scs-fsh-ifjmkpkdzceq",
9 "region": "fsh"
10 },
11 {
12 "memberId": "scs-fsh-luoreupenrtn",
13 "region": "fsh"
14 }
15 ]
16}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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 | 源端到目标端的连通性是否正常。 |
请求示例
Plain Text
1POST http://redis.fsh.baidubce.com/v2/syncGroup/check
2Host: redis.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "members": [
6 {
7 "memberId": "scs-fsh-ifjmkpkdzceq",
8 "region": "fsh"
9 },
10 {
11 "memberId": "scs-fsh-luoreupenrtn",
12 "region": "fsh"
13 }
14 ]
15}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6{
7 "checkResult": [
8 {
9 "memberId": "scs-fsh-ifjmkpkdzceq",
10 "noData": true,
11 "version": true,
12 "engineVersion": true,
13 "clusterStatus": true,
14 "shardNum": false,
15 "replicationNum": true,
16 "flavor": true,
17 "notJoined": true,
18 "noSecurityGroup": true,
19 "isHitX1": true,
20 "isAppendOnlyOn": true,
21 "samePasswd": true
22 },
23 {
24 "memberId": "scs-fsh-luoreupenrtn",
25 "noData": true,
26 "version": true,
27 "engineVersion": true,
28 "clusterStatus": true,
29 "shardNum": false,
30 "replicationNum": true,
31 "flavor": true,
32 "notJoined": true,
33 "noSecurityGroup": true,
34 "isHitX1": true,
35 "isAppendOnlyOn": true,
36 "samePasswd": true
37 }
38 ],
39 "connectionResults": [
40 {
41 "sourceId": "scs-fsh-ifjmkpkdzceq",
42 "targetId": "scs-fsh-luoreupenrtn",
43 "connectable": true
44 },
45 {
46 "sourceId": "scs-fsh-luoreupenrtn",
47 "targetId": "scs-fsh-ifjmkpkdzceq",
48 "connectable": true
49 }
50 ]
51}