查看集群列表
更新时间：2025-04-01
接口说明
查看集群列表，优化集群状态
请求URI
POST /api/bes/cluster/v2/list
请求头参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 否 | 区域 | bd |
请求体参数
请求体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| pageNo | Integer | 是 | 页数（从1开始取值） | 1 |
| pageSize | Integer | 是 | 页大小 | 10 |
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| success | Boolean | 操作是否成功 | true |
| status | Integer | 状态码 | 200 |
| page | Page | 集群信息列表 |
Page字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| pageNo | Integer | 页数 | 0 |
| pageSize | Integer | 页大小 | 10 |
| totalCount | Integer | 集群个数 | 1 |
ResultItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| clusterId | String | 集群ID | 572979545519558656 |
| clusterName | String | 集群名称 | postpaynew1 |
| createTime | String | 创建时间 | 2021-10-26 10:56:12 |
| actualStatus | String | 状态,active：正常，activating：生效中，invalid：失效 | active |
| runningTime | String | 运行时间 | 12 小时23 分钟 |
| region | String | 区域 | bj |
| version | String | 版本 | 7.10.2 |
| clusterHealth | ClusterHealth | ||
| billing | Billing | 集群计费信息 | |
| tags | List |
标签信息 | |
| resGroupList | List |
资源分组 | |
| innerAccessIp | String | 内部访问ip | 1.1.1.1 |
| accessEip | String | 访问的eip | 1.1.1.1 |
| vpcId | String | vpcId | xxx-xxx-xxx-xxx |
| subnet | List |
子网信息 | |
| network | List |
网络信息 |
ClusterHealth字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| status | String | 健康状态 | GREEN(健康)、YELLOW(亚健康)、RED(不健康) |
Billing字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| paymentType | String | 计费类型 | postpay |
TagsItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| tagKey | String | 标签key | test |
| tagValue | String | 标签value | 111 |
ResGroupListItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| groupId | String | 资源分组id | RESG-44pvmsruNiy |
| groupName | String | 资源分组名称 | 默认分组 |
SubnetItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| availableZone | String | 可用区名称 | zoneA |
| subnetName | String | 字网名称 | 系统预定义子网 |
NetworkItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| subnetId | String | 子网id | xxx-xxx-xxx-xxx-xxx |
请求示例
Plain Text
1POST /api/bes/cluster/v2/list
2<公共请求头>
3x-Region: bd
4
5
6{
7 "pageNo" : 1,
8 "pageSize" : 10
9}响应示例
Plain Text
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "success" : true,
6 "page" : {
7 "result" : [ {
8 "resGroupList" : [ {
9 "groupName" : "默认分组",
10 "groupId" : "RESG-44pvmsruNiy"
11 }, {
12 "groupName" : "默认分组",
13 "groupId" : "RESG-44pvmsruNiy"
14 } ],
15 "subnet" : [ {
16 "availableZone" : "zoneA",
17 "subnetName" : "系统预定义子网"
18 }, {
19 "availableZone" : "zoneA",
20 "subnetName" : "系统预定义子网"
21 } ],
22 "accessEip" : "1.1.1.1",
23 "clusterId" : "572979545519558656",
24 "runningTime" : "12 小时23 分钟",
25 "clusterHealth" : {
26 "status" : "GREEN(健康)、YELLOW(亚健康)、RED(不健康)"
27 },
28 "version" : "7.10.2",
29 "billing" : {
30 "paymentType" : "postpay"
31 },
32 "tags" : [ {
33 "tagValue" : "111",
34 "tagKey" : "test"
35 }, {
36 "tagValue" : "111",
37 "tagKey" : "test"
38 } ],
39 "network" : [ {
40 "subnetId" : "xxx-xxx-xxx-xxx-xxx"
41 }, {
42 "subnetId" : "xxx-xxx-xxx-xxx-xxx"
43 } ],
44 "actualStatus" : "active",
45 "createTime" : "2021-10-26 10:56:12",
46 "innerAccessIp" : "1.1.1.1",
47 "clusterName" : "postpaynew1",
48 "vpcId" : "xxx-xxx-xxx-xxx",
49 "region" : "bj"
50 }, {
51 "resGroupList" : [ {
52 "groupName" : "默认分组",
53 "groupId" : "RESG-44pvmsruNiy"
54 }, {
55 "groupName" : "默认分组",
56 "groupId" : "RESG-44pvmsruNiy"
57 } ],
58 "subnet" : [ {
59 "availableZone" : "zoneA",
60 "subnetName" : "系统预定义子网"
61 }, {
62 "availableZone" : "zoneA",
63 "subnetName" : "系统预定义子网"
64 } ],
65 "accessEip" : "1.1.1.1",
66 "clusterId" : "572979545519558656",
67 "runningTime" : "12 小时23 分钟",
68 "clusterHealth" : {
69 "status" : "GREEN(健康)、YELLOW(亚健康)、RED(不健康)"
70 },
71 "version" : "7.10.2",
72 "billing" : {
73 "paymentType" : "postpay"
74 },
75 "tags" : [ {
76 "tagValue" : "111",
77 "tagKey" : "test"
78 }, {
79 "tagValue" : "111",
80 "tagKey" : "test"
81 } ],
82 "network" : [ {
83 "subnetId" : "xxx-xxx-xxx-xxx-xxx"
84 }, {
85 "subnetId" : "xxx-xxx-xxx-xxx-xxx"
86 } ],
87 "actualStatus" : "active",
88 "createTime" : "2021-10-26 10:56:12",
89 "innerAccessIp" : "1.1.1.1",
90 "clusterName" : "postpaynew1",
91 "vpcId" : "xxx-xxx-xxx-xxx",
92 "region" : "bj"
93 } ],
94 "pageNo" : 0,
95 "pageSize" : 10,
96 "totalCount" : 1
97 },
98 "status" : 200
99}错误码
请参考通用错误码