文档首页> 云搜索服务 CSS> API参考> 集群管理接口> 查询集群详情
更新时间：2024-04-22 GMT+08:00
查看PDF

查询集群详情

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

指定查询集群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。

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地址和端口号。
表3 ClusterDetailDatastore

参数

参数类型

描述

type

String

引擎类型，支持elasticsearch和logstash。

version

String

CSS集群引擎版本号。详细请参考CSS支持的集群版本。

supportSecuritymode

Boolean

支持安全模式
表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

详细错误信息。

请求示例

无

响应示例

状态码： 200

请求已成功。

{
  "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}" ]
    },
    "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
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

404

所请求的资源不存在。

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

错误码

请参见错误码。

父主题： 集群管理接口