根据id查询集群基本信息

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String 是 hb-bp16f1441y6p2kv**

要查询的集群id

返回数据

名称 类型 示例值 描述
BackupStatus String open

备份恢复状态：

open-展示备份恢复

close-不展示备份恢复
ColdStorageStatus String open

冷热分离状态：

open-有冷热分离页面

close-无冷热分离页面
CoreDiskCount String 2

Core磁盘数量
CoreDiskSize Integer 100

core节点磁盘大小，默认单位G
CoreDiskType String cloud_efficiency

core节点磁盘类型

cloud_efficiency 高效云盘

cloud_ssd ssd云盘
CoreInstanceType String hbase.sn1.large

core节点实例类型
CoreNodeCount Integer 2

core节点个数
CreatedTime String 2019-09-12T14:40:46

集群创建时间
Engine String hbase

产品引擎

hbase

spark

geomesa

...
ExpireTime String 2019-10-12T14:40:46

失效时间
InstanceId String hb-bp16f1441y6p2kv**

集群ID。系统生成的唯一标识码
InstanceName String openapi-test

集群name，用户可自行设置
IsHa Boolean true

是否高可用？true/false
MajorVersion String 2.0

主版本号
MasterDiskSize Integer 100

主节点磁盘大小，默认单位G
MasterDiskType String cloud_efficiency

主节点磁盘类型

cloud_efficiency 高效云盘

cloud_ssd ssd云盘
MasterInstanceType String hbase.sn1.large

主节点实例类型
MasterNodeCount Integer 2

主节点个数

为单节点时既是master也是core,此时返回0

为ha高可用时是2
MinorVersion String 2.0.8

小版本号
NetworkType String VPC

网络类型，

VPC VPC网络类型

CLASSIC 经典网络类型

如果为VPC, 就有vSwitchId, vpcId
PayType String Postpaid

付费类型：

  • Prepaid：预付费
  • Postpaid：后付费
RegionId String cn-shanghai

实例所属地域ID
RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4D6**

request Id 自动生成的唯一请求标识码
Status String ACTIVATION

集群状态

CREATING创建中

ACTIVATION运行中

DELETING删除中

RESTARTING重启中...
Tags Array

资源标签
Tag

资源标签
Key String test_key

标签Key值
Value String test_value

标签Value值
VpcId String vpc-bp120k6ixs4eoghz*****

专有网络vpcId，NetworkType为2时会有，vpc-xxxx
VswitchId String vsw-bp191ipotq****dbqf

虚拟交换机id，NetworkType为2时会有，vsw-xxxx
ZoneId String cn-hangzhou-f

实例所属可用区ID

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeInstance
&ClusterId=hb-bp16f1441y6p2kv**
&<公共请求参数>

正常返回示例

XML 格式 

<InstanceId>hb-bp16o0pd52e3y582s</InstanceId>
<ZoneId>cn-hangzhou-f</ZoneId>
<MasterDiskSize>0</MasterDiskSize>
<VpcId>vpc-bp120k6ixs4eoghz*****</VpcId>
<Engine>hbase</Engine>
<MajorVersion>2.0</MajorVersion>
<CoreNodeCount>4</CoreNodeCount>
<NetworkType>VPC</NetworkType>
<CoreDiskType>cloud_ssd</CoreDiskType>
<MasterDiskType/>
<CoreInstanceType>hbase.sn1.large</CoreInstanceType>
<VswitchId>vsw-bp191ipotq****dbqf</VswitchId>
<CoreDiskSize>100</CoreDiskSize>
<PayType>PayAsYouGo</PayType>
<InstanceName>wangjk-HBase</InstanceName>
<MasterInstanceType>hbase.sn1.medium</MasterInstanceType>
<CreatedTime>2019-09-12T14:40:46</CreatedTime>
<Status>ACTIVATION</Status>
<MinorVersion>2.0.8</MinorVersion>
<ColdStorageStatus>open</ColdStorageStatus>
<RequestId>EBECBF12-2E34-41BE-8DE9-FC3700D4D6C6</RequestId>
<RegionId>cn-hangzhou</RegionId>
<MasterNodeCount>2</MasterNodeCount>
<BackupStatus>open</BackupStatus>

JSON 格式 

{
	"CreatedTime":"2019-09-12T14:40:46",
	"InstanceId":"hb-bp16o0pd52e3y582s",
	"ZoneId":"cn-hangzhou-f",
	"MasterDiskSize":0,
	"VpcId":"vpc-bp120k6ixs4eoghz*****",
	"Engine":"hbase",
	"MajorVersion":"2.0",
	"CoreNodeCount":4,
	"Status":"ACTIVATION",
	"NetworkType":"VPC",
	"CoreDiskType":"cloud_ssd",
	"MinorVersion":"2.0.8",
	"ColdStorageStatus":"open",
	"MasterDiskType":"",
	"RegionId":"cn-hangzhou",
	"RequestId":"EBECBF12-2E34-41BE-8DE9-FC3700D4D6C6",
	"CoreInstanceType":"hbase.sn1.large",
	"MasterNodeCount":2,
	"VswitchId":"vsw-bp191ipotq****dbqf",
	"BackupStatus":"open",
	"CoreDiskSize":100,
	"InstanceName":"wangjk-HBase",
	"PayType":"PayAsYouGo",
	"MasterInstanceType":"hbase.sn1.medium"
}

错误码

访问错误中心查看更多错误码。