文档首页/ 表格存储服务 CloudTable/ API参考/ CloudTable集群管理接口V2/ 查询CloudTable集群列表
更新时间：2023-12-04 GMT+08:00
查看PDF
分享

查询CloudTable集群列表

功能介绍

查看用户创建的集群列表信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/clusters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法，请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，默认为0，取值范围offset>=0。

limit

否

Integer

限制量，单次查询总量，默认为10,取值范围limit>0。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

clusters

Array of ClusterDetail objects

查询到的集群详细列表，每个json体表示一个集群的详情。

count

Integer

查询到的集群数量。
表4 ClusterDetail

参数

参数类型

描述

action_progress

ActionProgress object

集群操作进度，任务信息，由key、value组成。key值为正在进行的任务，value值为正在进行任务的进度。示例如 "action_progress":{"SNAPSHOTTING":"16%"}。

actions

Array of strings

集群操作记录。

auth_mode

String

是否开启IAM权限认证。

  • false：不开启
  • true：开启

    备注：此字段废弃。

az_code

String

集群所在的可用区（AZ)。

cluster_id

String

集群ID，集群唯一标识。

cluster_name

String

CloudTable集群名称。

created

String

集群创建时间。

enable_dfv

String

是否开启DFV。

  • false：不开启
  • true：开启

enable_free

String

集群是否免费。

  • false：不免费
  • true：免费

enable_lemon

String

是否开启Lemon。

  • false：不开启
  • true：开启

    备注：此字段废弃。

enable_openTSDB

String

是否开启OpenTSDB。

  • false：不开启
  • true：开启

    备注：此字段只适用于HBase1.3.1版本。

status

String

集群状态：

  • 200：集群正常
  • 300：集群异常
  • 303：集群创建失败
  • 400：集群已删除

tags

String

集群标识符。

version

String

集群版本号。

zookeeper_link

String

CloudTable集群ZooKeeper的链接地址。例如：cloudtable-3058-zk3-Dqcwuh6R.mycloudtable.com:2181,cloudtable-3058-zk2-TCwkZEie.mycloudtable.com:2181,cloudtable-3058-zk1-TBELUFOK.mycloudtable.com:2181
表5 ActionProgress

参数

参数类型

描述

CREATING

String

创建集群进度，例如：29%

GROWING

String

扩容集群进度，例如：29%

RESTORING

String

恢复集群进度，例如：29%

SNAPSHOTTING

String

集群快照进度，例如：29%

REPAIRING

String

修复集群进度，例如：29%

请求示例

查询集群接口URI格式。

GET  /v2/{project_id}/clusters?offset=0&limit=10

响应示例

状态码： 200

查询集群列表成功（lemon字段废弃，enable_openTSDB字段只适用于HBase1.3.1版本）。

{
  "clusters" : [ {
    "cluster_name" : "cloudtable-3058",
    "cluster_id" : "24cebcf3-8c51-493e-84ae-4c0bd2d2334d",
    "status" : "200",
    "version" : "v1.1.16",
    "created" : "2019-02-21T01:51:49",
    "zookeeper_link" : "cloudtable-3058-zk3-Dqcwuh6R.mycloudtable.com:2181,cloudtable-3058-zk2-TCwkZEie.mycloudtable.com:2181,cloudtable-3058-zk1-TBELUFOK.mycloudtable.com:2181",
    "az_code" : "kvmxen.dc1",
    "actions" : [ ],
    "action_progress" : { },
    "enable_dfv" : "true",
    "enable_lemon" : "false",
    "enable_openTSDB" : "false",
    "enable_free" : "false",
    "auth_mode" : "false"
  }, {
    "cluster_name" : "cloudtable-ES",
    "cluster_id" : "8907e9cc-0e6d-4f86-a719-b7971f84ebe0",
    "status" : "200",
    "version" : "v1.1.16",
    "created" : "2019-02-21T00:52:14",
    "zookeeper_link" : "cloudtable-es-zk3-iQd6HzKa.mycloudtable.com:2181,cloudtable-es-zk1-dCmsgqrb.mycloudtable.com:2181,cloudtable-es-zk2-mTR1TS4c.mycloudtable.com:2181",
    "az_code" : "kvmxen.dc1",
    "actions" : [ ],
    "action_progress" : { },
    "enable_dfv" : "true",
    "enable_lemon" : "false",
    "enable_openTSDB" : "false",
    "enable_free" : "false",
    "auth_mode" : "false"
  } ],
  "count" : 2
}

状态码

状态码

描述

200

查询集群列表成功。

相关文档