查询集群列表
功能介绍
该接口用于查询并显示集群列表以及集群的状态。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/clusters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID和名称。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start |
否 |
Integer |
指定查询起始值，默认值为1，即从第1个集群开始查询。 |
|
limit |
否 |
Integer |
指定查询个数，默认值为10，即一次查询10个集群信息。 |
|
datastoreType |
否 |
String |
集群引擎类型。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
totalSize |
Integer |
集群个数。 |
|
clusters |
Array of ClusterList objects |
集群对象列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
datastore |
ClusterListDatastore object |
数据搜索引擎类型。 |
|
instances |
Array of ClusterListInstances objects |
节点对象列表。 |
|
publicKibanaResp |
publicKibanaRespBody object |
Kibana公网访问信息。 |
|
elbWhiteList |
elbWhiteListResp object |
弹性IP白名单列表。 |
|
updated |
String |
集群上次修改时间，格式为ISO8601： CCYY-MM-DDThh:mm:ss。 |
|
name |
String |
集群名称。 |
|
publicIp |
String |
公网IP信息。 |
|
created |
String |
集群创建时间，格式为ISO8601：CCYY-MM-DDThh:mm:ss。 返回的集群列表信息按照创建时间降序排序，即创建时间最新的集群排在最前。 |
|
id |
String |
集群ID。 |
|
status |
String |
集群状态值。
|
|
endpoint |
String |
集群内网访问IPv4地址和端口号。 |
|
vpcId |
String |
VPC ID。 |
|
subnetId |
String |
子网ID。 |
|
securityGroupId |
String |
安全组ID。 |
|
bandwidthSize |
Integer |
公网带宽大小。单位：Mbit/s |
|
httpsEnable |
Boolean |
通信加密状态。
|
|
authorityEnable |
Boolean |
是否开启认证。
|
|
diskEncrypted |
Boolean |
磁盘是否加密。
|
|
backupAvailable |
Boolean |
快照是否开启。
|
|
actionProgress |
Object |
集群行为进度，显示创建或扩容进度的百分比等。CREATING表示创建的百分比。 |
|
actions |
Array of strings |
集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。 |
|
enterpriseProjectId |
String |
集群所属的企业项目ID。 如果集群所属用户没有开通企业项目，则不会返回该参数。 |
|
tags |
Array of ClusterListTags objects |
集群标签。 |
|
failedReason |
ClusterListFailedReasons object |
失败原因。如果集群处于正常状态，则不返回该参数。 |
|
bandwidthResourceId |
String |
es公网访问的资源id。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
引擎类型，支持elasticsearch。 |
|
version |
String |
CSS集群引擎版本号。详细请参考CSS支持的集群版本。 |
|
supportSecuritymode |
Boolean |
是否支持安全模式。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
节点状态值。
|
|
type |
String |
当前节点的类型。 |
|
id |
String |
实例ID。 |
|
name |
String |
实例名字。 |
|
specCode |
String |
节点规格名称。 |
|
azCode |
String |
节点所属AZ信息。 |
|
ip |
String |
实例ip信息。 |
|
volume |
ClusterVolumeRsp object |
实例磁盘信息。 |
|
resourceId |
String |
该实例对应的资源Id。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
实例磁盘类型。 |
|
size |
Integer |
实例磁盘大小。 |
|
resourceIds |
Array of strings |
该实例拥有的磁盘对应的资源Id。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
eipSize |
Integer |
带宽大小。单位：Mbit/s |
|
elbWhiteListResp |
kibanaElbWhiteListResp object |
Kibana公网访问信息。 |
|
publicKibanaIp |
String |
kibana访问IP。 |
|
bandwidthResourceId |
String |
当前kibana公网对应的资源Id。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
enableWhiteList |
Boolean |
是否开启kibana访问控制。
|
|
whiteList |
String |
kibana公网访问白名单。 |
请求示例
- 查询前2个集群
- 方法1：GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=2 - 方法2：GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=2
- 查询前10个集群
- 方法1：GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=10 - 方法2：GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=10
响应示例
状态码： 200
请求已成功。
{
"totalSize" : 1,
"clusters" : [ {
"datastore" : {
"type" : "elasticsearch",
"version" : "7.10.2",
"supportSecuritymode" : false
},
"instances" : [ {
"status" : "200",
"type" : "ess",
"id" : "{INSTANCE_ID}",
"name" : "css-8bc5-ess-esn-1-1",
"specCode" : "ess.spec-4u8g",
"azCode" : "{AZ_CODE}",
"volume" : {
"type" : "ULTRAHIGH",
"size" : 40,
"resourceIds" : [ "{RESOURCE_ID}" ]
},
"ip" : "192.168.0.122",
"resourceId" : "{RESOURCE_ID}"
} ],
"publicKibanaResp" : {
"eipSize" : 10,
"publicKibanaIp" : "100.95.152.28:9200",
"elbWhiteListResp" : null,
"bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
},
"elbWhiteList" : {
"whiteList" : "",
"enableWhiteList" : false
},
"updated" : "2023-10-09T02:07:13",
"name" : "css-8bc5",
"publicIp" : "100.85.222.202",
"created" : "2023-10-09T02:07:13",
"id" : "{CLUSTER_ID}",
"status" : "200",
"vpcId" : "{VPC_ID}",
"subnetId" : "{SUBNET_ID}",
"securityGroupId" : "{SECURITY_GROUP_ID}",
"bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
"bandwidthSize" : 3,
"httpsEnable" : true,
"authorityEnable" : true,
"diskEncrypted" : false,
"backupAvailable" : false,
"actionProgress" : { },
"actions" : [ ],
"enterpriseProjectId" : "0",
"tags" : [ ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求，不要重试该请求。 |
|
404 |
所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
