前置检查
更新时间：2023-09-06
请求说明
热活实例组前置检查，检查数据配置及网络联通性，不通过检查不能创建。
- leader：主角色类型。
- follower：从角色类型。
请求结构
Plain Text
1POST /v2/group/check HTTP/1.1
2Host: redis.{region}.baidubce.com
3Authorization: authorization string
4{
5 "leader" : {
6 "leaderRegion" : "leaderRegion",
7 "leaderId" : "leaderId"
8 },
9 "followers" : [ {
10 "followerId" : "followerId",
11 "followerRegion" : "followerRegion"
12 } ]
13}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| leader | Leader | 是 | RequestBody参数 | 主角色信息 |
| followers | List<FollowersItem> | 否 | RequestBody参数 | 从角色信息 |
Leader
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| leaderId | String | 是 | 热活实例组主角色实例ID |
| leaderRegion | String | 是 | 热活实例组主角色所在地域 |
FollowersItem
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| followerId | String | 是 | 从角色实例ID |
| followerRegion | String | 是 | 从角色实例所在地域 |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| connectionResults | List<ConnectionResults> | 如果存在多个实例，检查主从、从从之间的网络联通性 |
| leaderResult | LeaderResult | 主角色实例数据配置检查结果 |
| followerResult | List<FollowerResult> | 从角色实例数据配置检查结果 |
ConnectionResults
| 参数名称 | 类型 | 描述 |
|---|---|---|
| sourceId | String | 源端集群ID |
| sourceRole | String | 源端集群角色 |
| targetId | String | 目标端集群ID |
| targetRole | String | 目标端集群角色 |
| connectable | Boolean | 是否连通（true:连通 false：不连通） |
LeaderResult
| 参数名称 | 类型 | 描述 |
|---|---|---|
| version | Boolean | 版本是否为集群版（true:是，false：否） |
| clusterStatus | Boolean | 集群状态是否是running（true:是，false：否） |
| replicationNum | Boolean | 副本数（true:是，false：否）（主角色副本数需为2） |
| flavor | Boolean | 单分片容量（true:是，false：否）（主角色单分片在8G及以下） |
| joined | Boolean | 是否已加入热活实例组（true：是，false：否） |
| noPasswd | Boolean | 是否无密码（true：是，false：否） |
| noSecurityGroup | Boolean | 是否无vpc侧安全组（true：是， false：否） |
| isHitX1 | Boolean | 是否是新架构（true:是 false：否） |
FollowerResult
| 参数名称 | 类型 | 描述 |
|---|---|---|
| followerId | String | 从角色ID |
| noData | Boolean | 是否没有数据（true:是，false: 否） |
| version | Boolean | 版本是否为集群版（true:是，false：否） |
| clusterStatus | Boolean | 集群状态是否是running（true:是，false：否） |
| shardNum | Boolean | 分片数是否和主一致（true:是，false：否） |
| replicationNum | Boolean | 副本数（true:是，false：否）（主角色副本数需为2） |
| flavor | Boolean | 单分片容量（true:是，false：否）（主角色单分片在8G及以下） |
| joined | Boolean | 是否已加入热活实例组（true：是，false：否） |
| noPasswd | Boolean | 是否无密码（true：是，false：否） |
| noSecurityGroup | Boolean | 是否无VPC侧安全组（true：是， false：否） |
| isHitX1 | Boolean | 是否是新架构（true:是 false：否） |
请求示例
Plain Text
1POST /v2/group/check HTTP/1.1
2HOST: redis.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "leader" : {
8 "leaderRegion" : "bj",
9 "leaderId" : "scs-bj-bdtzbvlmghbu"
10 },
11 "followers" : [ {
12 "followerId" : "scs-bdbl-dzkqigawuhzy",
13 "followerRegion" : "bd"
14 } ]
15}返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
4{
5 "leaderResult": {
6 "version": true,
7 "clusterStatus": true,
8 "replicationNum": true,
9 "flavor": true,
10 "joined": false,
11 "noPasswd": true,
12 "noSecurityGroup": true,
13 "isHitX1": true
14 },
15 "followerResult": [
16 {
17 "followerId": "scs-bdbl-dzkqigawuhzy",
18 "noData": false,
19 "version": false,
20 "engineVersion": true,
21 "clusterStatus": false,
22 "shardNum": false,
23 "replicationNum": true,
24 "flavor": true,
25 "joined": false,
26 "noPasswd": true,
27 "noSecurityGroup": true,
28 "isHitX1": true
29 }
30 ],
31 "connectionResults": [
32 {
33 "sourceId": "scs-bj-bdtzbvlmghbu",
34 "sourceRole": "leader",
35 "targetId": "scs-bdbl-dzkqigawuhzy",
36 "targetRole": "follower",
37 "connectable": true
38 }
39 ]
40}