查询集群详情

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

datastore

ClusterDetailDatastore object

参数解释：

集群数据搜索引擎类型。

取值范围：

不涉及

instances

Array of ClusterDetailInstances objects

参数解释：

节点对象列表。

取值范围：

不涉及

publicKibanaResp

publicKibanaRespBody object

参数解释：

公网访问信息，包括IP地址、白名单、宽带信息等。

取值范围：

• Kibana：Elasticsearch集群的公网访问信息。

• Dashboards：OpenSearch集群的公网访问信息。

elbWhiteList

elbWhiteListResp object

参数解释：

Elb公网访问控制信息。

取值范围：

不涉及

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，即虚拟私有云ID。

取值范围：

不涉及

subnetId

String

参数解释：

集群当前的子网。此子网用于新增节点，包括扩容、添加独立Master/Client节点、开启终端节点服务，新增节点将通过当前子网申请IP并绑定。

取值范围：

不涉及

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：表示集群不开启安全模式认证。

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

参数解释：

集群变更任务的失败原因。如果集群处于正常状态，则不返回该参数。

取值范围：

不涉及

bandwidthResourceId

String

参数解释：

公网访问的资源ID。

取值范围：

不涉及

ipv6Endpoint

String

参数解释：

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

取值范围：

不涉及

supportVpcep

Boolean

参数解释：

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

取值范围：

• true：支持。

• false：不支持。

currentSubnetIds

String

参数解释：

集群当前所有节点用到的子网，如果存在多个（最多支持两个），使用英文逗号隔开。

取值范围：

不涉及

desc

String

参数解释：

集群描述。

取值范围：

长度不超过128个字符。

type

String

参数解释：

引擎类型。

取值范围：

• elasticsearch：基于开源Elasticsearch提供在线分布式搜索、日志统计报表、语义搜索等功能。

• logstash：基于开源OpenSearch提供分布式搜索、日志统计报表、语义搜索等功能。

• opensearch：基于开源Logstash提供数据收集、转换、清洗、解析等功能。

version

String

参数解释：

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

取值范围：

不涉及

subVersion

String

参数解释：

集群发布版本号。

取值范围：

不涉及

isEosCluster

Boolean

参数解释：

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

取值范围：

• true：表示过期。

• false：表示未过期。

supportSecuritymode

Boolean

'参数解释：

集群认证是否支持安全模式。

取值范围：

• true：支持。

• false：不支持。

status

String

参数解释：

节点状态值。

取值范围：

• 100：创建中。

• 200：可用。

• 303：不可用，如创建失败。

resourceId

String

参数解释：

该实例对应的计费资源ID。

取值范围：

不涉及

type

String

参数解释：

当前节点类型。

取值范围：

• ess：数据节点。

• ess-cold：冷数据节点。

• ess-client：Client节点。

• ess-master：Master节点。

• lgs：LogStash节点。

id

String

参数解释：

实例ID。

取值范围：

不涉及

name

String

参数解释：

实例名字。

取值范围：

不涉及

specCode

String

参数解释：

节点规格名称。

取值范围：

不涉及

azCode

String

参数解释：

节点所属可用区信息。

取值范围：

不涉及

ip

String

参数解释：

实例IP信息。

取值范围：

不涉及

volume

ShowClusterVolumeRsp object

参数解释：

实例磁盘信息。

取值范围：

不涉及

subnetId

String

参数解释：

当前节点所属子网ID。

取值范围：

不涉及

type

String

参数解释：

实例磁盘类型。

取值范围：

• COMMON：普通I/O

• HIGH：高I/O

• ULTRAHIGH：超高I/O

• ESSD：极速SSD

size

Integer

参数解释：

实例磁盘大小。

取值范围：

不涉及

resourceIds

Array of strings

参数解释：

该实例拥有的磁盘对应的计费资源ID。

取值范围：

不涉及

eipSize

Integer

参数解释：

Kibana公网访问或Dashboards公网访问的带宽大小，单位：Mbit/s。

取值范围：

不涉及

elbWhiteListResp

kibanaElbWhiteListResp object

参数解释：

kibana公网访问或Dashboards公网访问控制信息。

取值范围：

不涉及

publicKibanaIp

String

参数解释：

kibana访问或Dashboards访问IP地址。

取值范围：

不涉及

bandwidthResourceId

String

参数解释：

当前kibana公网或Dashboards对应的资源ID。

取值范围：

不涉及

enableWhiteList

Boolean

参数解释：

是否开启kibana访问或Dashboards访问控制白名单。

取值范围：

• true: 开启访问控制白名单。

• false: 关闭访问控制白名单。

whiteList

String

参数解释：

kibana公网访问或Dashboards公网访问白名单。

取值范围：

IP地址。

enableWhiteList

Boolean

参数解释：

是否开启Elb公网访问控制。设置访问白名单，表示只允许白名单列表中的IP地址访问集群；不设置白名单，所有的IP地址都可以访问集群。

取值范围：

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

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

whiteList

String

参数解释：

Elb公网访问白名单。

取值范围：

IP地址。

key

String

参数解释：

集群标签的key值。

取值范围：

不涉及

value

String

参数解释：

集群标签的value值。

取值范围：

不涉及

errorCode

String

参数解释：

错误码。

取值范围：

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

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

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

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

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

errorMsg

String

参数解释：

详细错误信息。

取值范围：

不涉及

200

请求已成功。

400

非法请求。

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

404

所请求的资源不存在。

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