文档首页/ 云搜索服务 CSS/ API参考/ 集群管理接口/ 查询集群列表

更新时间：2024-10-17 GMT+08:00

查看PDF

查询集群列表

功能介绍

该接口用于查询并显示集群列表以及集群的状态。

调试

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

URI

GET /v1.0/{project_id}/clusters

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID和名称。

表2 Query参数
参数	是否必选	参数类型	描述
start	否	Integer	指定查询起始值，默认值为1，即从第1个集群开始查询。
limit	否	Integer	指定查询个数，默认值为10，即一次查询10个集群信息。
datastoreType	否	String	集群引擎类型。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
totalSize	Integer	集群个数。
clusters	Array of ClusterList objects	集群对象列表。

表4 ClusterList
参数	参数类型	描述
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	集群状态值。 100：创建中。 200：可用。 303：不可用，如创建失败。
endpoint	String	集群内网访问IPv4地址和端口号。
vpcId	String	VPC ID。
subnetId	String	子网ID。
securityGroupId	String	安全组ID。
bandwidthSize	Integer	公网带宽大小。单位：Mbit/s
httpsEnable	Boolean	通信加密状态。 false：未设置通信加密。 true：已设置通信加密。
authorityEnable	Boolean	是否开启认证。 true：表示集群开启认证。 false：表示集群不开启认证。
diskEncrypted	Boolean	磁盘是否加密。 true : 磁盘已加密。 false : 磁盘未加密。
backupAvailable	Boolean	快照是否开启。 true: 快照开启状态。 false: 快照关闭状态。
actionProgress	Object	集群行为进度，显示创建或扩容进度的百分比等。CREATING表示创建的百分比。
actions	Array of strings	集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。
enterpriseProjectId	String	集群所属的企业项目ID。如果集群所属用户没有开通企业项目，则不会返回该参数。
tags	Array of ClusterListTags objects	集群标签。
failedReason	ClusterListFailedReasons object	失败原因。如果集群处于正常状态，则不返回该参数。
period	Boolean	是否为包周期集群。 "true" 表示是包周期计费的集群。 "false" 表示是按需计费的集群。
bandwidthResourceId	String	es公网访问的资源id。
ipv6Endpoint	String	集群内网访问IPv6地址和端口号。

表5 ClusterListDatastore
参数	参数类型	描述
type	String	引擎类型，支持elasticsearch，logstash。
version	String	CSS集群引擎版本号。详细请参考CSS支持的集群版本。
supportSecuritymode	Boolean	是否支持安全模式。
subVersion	String	集群镜像发布版本号。
isEosCluster	Boolean	表示集群镜像发布版本是否EOS，true表示过期，false表示不过期。

表6 ClusterListInstances
参数	参数类型	描述
status	String	节点状态值。 100：创建中。 200：可用。 303：不可用，如创建失败。
type	String	当前节点的类型。
id	String	实例ID。
name	String	实例名字。
specCode	String	节点规格名称。
azCode	String	节点所属AZ信息。
ip	String	实例ip信息。
volume	ClusterVolumeRsp object	实例磁盘信息。
resourceId	String	该实例对应的资源Id。

表7 ClusterVolumeRsp
参数	参数类型	描述
type	String	实例磁盘类型。
size	Integer	实例磁盘大小。
resourceIds	Array of strings	该实例拥有的磁盘对应的资源Id。

表8 publicKibanaRespBody
参数	参数类型	描述
eipSize	Integer	带宽大小。单位：Mbit/s
elbWhiteListResp	kibanaElbWhiteListResp object	Kibana公网访问信息。
publicKibanaIp	String	kibana访问IP。
bandwidthResourceId	String	当前kibana公网对应的资源Id。

表9 kibanaElbWhiteListResp
参数	参数类型	描述
enableWhiteList	Boolean	是否开启kibana访问控制。 true: 开启访问控制。 false: 关闭访问控制
whiteList	String	kibana公网访问白名单。

**表10** elbWhiteListResp
参数	参数类型	描述
enableWhiteList	Boolean	是否开启公网访问控制。 true: 开启公网访问控制。 false: 关闭公网访问控制。
whiteList	String	公网访问白名单。

**表11** ClusterListTags
参数	参数类型	描述
key	String	集群标签的key值。
value	String	集群标签的value值。

**表12** ClusterListFailedReasons
参数	参数类型	描述
errorCode	String	错误码。 CSS.6000：表示集群创建失败。 CSS.6001：表示集群扩容失败。 CSS.6002：表示集群重启失败。 CSS.6004：表示集群节点创建失败。 CSS.6005：表示服务初始化失败。
errorMsg	String	详细错误信息。

请求示例

查询前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",
      "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}" ]
      },
      "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",
    "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	所请求的资源不存在。建议直接修改该请求，不要重试该请求。

描述

200

请求已成功。

400

非法请求。

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

404

所请求的资源不存在。

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

错误码

请参见错误码。

父主题： 集群管理接口

上一篇：创建集群

下一篇：查询集群详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消