更新时间:2025-01-22 GMT+08:00

查询集群详情

功能介绍

该接口用于查询并显示单个集群详情。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

URI

GET /v1.0/{project_id}/clusters/{cluster_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。获取方法请参见获取项目ID和名称

约束限制:

不涉及

取值范围:

获取方法请参见获取项目ID和名称

默认取值:

不涉及

cluster_id

String

参数解释:

指定待查询的集群ID,获取方法请参见获取集群ID

约束限制:

不涉及

取值范围:

获取方法请参见获取集群ID

默认取值:

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

datastore

ClusterDetailDatastore object

参数解释:

数据搜索引擎类型。

instances

Array of ClusterDetailInstances objects

参数解释:

节点对象列表。

publicKibanaResp

publicKibanaRespBody object

参数解释:

Kibana公网访问信息。

elbWhiteList

elbWhiteListResp object

参数解释:

公网访问控制信息。

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

参数解释:

集群状态值。

取值范围:

  • 100:操作进行中,如创建中。

  • 200:可用。

  • 303:不可用,如创建失败。

endpoint

String

参数解释:

集群内网访问IPv4地址和端口号。

vpcId

String

参数解释:

VPC ID。

subnetId

String

参数解释:

子网ID。

securityGroupId

String

参数解释:

安全组ID。

vpcepIp

String

参数解释:

终端节点IP。

vpcepIpv6Address

String

参数解释:

终端节点IPv6。

bandwidthSize

Integer

参数解释:

公网带宽大小。单位:Mbit/s

httpsEnable

Boolean

参数解释:

通信加密状态。

取值范围:

  • false:未设置通信加密。

  • true:已设置通信加密。

diskEncrypted

Boolean

参数解释:

磁盘是否加密。

取值范围:

  • true : 磁盘已加密。

  • false : 磁盘未加密。

authorityEnable

Boolean

参数解释:

是否开启认证,取值范围为true或false。默认关闭认证功能。

取值范围:

  • true:表示集群开启认证。

  • false:表示集群不开启认证。

backupAvailable

Boolean

参数解释:

快照是否开启。

取值范围:

  • true: 快照开启状态。

  • false: 快照关闭状态。

actionProgress

Object

参数解释:

集群行为进度,显示创建或扩容进度的百分比。

actions

Array of strings

参数解释:

集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。

enterpriseProjectId

String

参数解释:

集群所属的企业项目ID。

如果集群所属用户没有开通企业项目,则不会返回该参数。

tags

Array of ClusterDetailTags objects

参数解释:

集群标签。

failedReason

ClusterDetailFailedReasons object

参数解释:

失败原因。如果集群处于正常状态,则不返回该参数。

period

Boolean

参数解释:

是否为包周期集群。

取值范围:

  • "true" 表示是包周期计费的集群。

  • "false" 表示是按需计费的集群。

bandwidthResourceId

String

参数解释:

公网访问的资源id。

ipv6Endpoint

String

参数解释:

集群内网访问IPv6地址和端口号。

supportVpcep

Boolean

参数解释:

当前集群是否支持开启终端节点服务。

表3 ClusterDetailDatastore

参数

参数类型

描述

type

String

参数解释:

引擎类型。

取值范围:

elasticsearch、logstash和opensearch。

version

String

参数解释:

CSS集群引擎版本号。详细请参考CSS使用前必读中支持的版本。

subVersion

String

参数解释:

集群镜像发布版本号。

isEosCluster

Boolean

参数解释:

表示集群镜像发布版本是否EOS。

取值范围:

true表示过期,false表示不过期。

表4 ClusterDetailInstances

参数

参数类型

描述

status

String

参数解释:

节点状态值。

取值范围:

  • 100:创建中。

  • 200:可用。

  • 303:不可用,如创建失败。

resourceId

String

参数解释:

该实例对应的资源Id。

type

String

参数解释:

当前节点的类型。

id

String

参数解释:

实例ID。

name

String

参数解释:

实例名字。

specCode

String

参数解释:

节点规格名称。

azCode

String

参数解释:

节点所属AZ信息。

privateIp

String

参数解释:

实例ip信息。

volume

ShowClusterVolumeRsp object

参数解释:

实例磁盘信息。

表5 ShowClusterVolumeRsp

参数

参数类型

描述

type

String

参数解释:

实例磁盘类型。

size

Integer

参数解释:

实例磁盘大小。

resourceIds

Array of strings

参数解释:

该实例拥有的磁盘对应的资源Id。

表6 publicKibanaRespBody

参数

参数类型

描述

eipSize

Integer

带宽大小。单位:Mbit/s

elbWhiteListResp

kibanaElbWhiteListResp object

参数解释:

kibana公网访问控制信息。

publicKibanaIp

String

参数解释:

kibana访问IP。

bandwidthResourceId

String

参数解释:

当前kibana公网对应的资源Id。

表7 kibanaElbWhiteListResp

参数

参数类型

描述

enableWhiteList

Boolean

是否开启kibana访问控制。

取值范围:

  • true: 开启访问控制。

  • false: 关闭访问控制

whiteList

String

参数解释:

kibana公网访问白名单。

表8 elbWhiteListResp

参数

参数类型

描述

enableWhiteList

Boolean

参数解释:

是否开启公网访问控制。

取值范围:

  • true: 开启公网访问控制。

  • false: 关闭公网访问控制。

whiteList

String

参数解释:

公网访问白名单。

表9 ClusterDetailTags

参数

参数类型

描述

key

String

参数解释:

集群标签的key值。

value

String

参数解释:

集群标签的value值。

表10 ClusterDetailFailedReasons

参数

参数类型

描述

errorCode

String

参数解释:

错误码。

取值范围:

  • CSS.6000:表示集群创建失败。

  • CSS.6001:表示集群扩容失败。

  • CSS.6002:表示集群重启失败。

  • CSS.6004:表示集群节点创建失败。

  • CSS.6005:表示服务初始化失败。

errorMsg

String

参数解释:

详细错误信息。

请求示例

查询集群详细信息。

GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/5c2bab0d-ec5f-491f-9418-b8da38a26760

响应示例

状态码:200

请求已成功。

{
  "datastore" : {
    "type" : "elasticsearch",
    "version" : "7.10.2",
    "subVersion" : "7.10.2_24.3.0_0827",
    "isEosCluster" : false,
    "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}" ]
    },
    "privateIp" : "192.168.0.122",
    "resourceId" : "{RESOURCE_ID}"
  } ],
  "publicKibanaResp" : {
    "eipSize" : 10,
    "publicKibanaIp" : "100.95.152.28",
    "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",
  "endpoint" : "192.168.0.122:9200",
  "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" : [ ],
  "period" : true,
  "supportVpcep" : true
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

404

所请求的资源不存在。

建议直接修改该请求,不要重试该请求。

错误码

请参见错误码