根据ID查询集群基本信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstance

系统规定参数。

ClusterId String ld-uf699153o1m2l-m****

目标集群ID。

返回数据

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

备份恢复状态,返回值:

  • open:展示备份恢复。
  • close:不展示备份恢复。
ClusterId String ld-uf699153o1m2l-m****

集群ID,系统生成的唯一标识码。等于InstanceId,建议统一使用ClusterId。

ClusterName String test

集群名称,等于InstanceName,建议统一使用ClusterName。

ClusterType String cluster

集群类型,返回值:

  • cluster
  • single
ColdStorageStatus String open

冷热分离状态,返回值:

  • open:有冷热分离页面。
  • close:无冷热分离页面。
CoreDiskCount String 4

Core磁盘数量。

CoreDiskSize Integer 100

Core节点磁盘大小,默认单位G。

CoreDiskType String cloud_ssd

Core节点磁盘类型,返回值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:ssd云盘。
CoreInstanceType String hbase.sn2.2xlarge

Core节点实例类型。

CoreNodeCount Integer 2

Core节点个数。

CreatedTime String 2020-07-20T20:28:12

集群创建时间。

CreatedTimeUTC String 2020-07-20T20:28:12Z

集群创建时间,UTC格式。

Engine String hbaseue

产品引擎类型。

  • hbase
  • hbaseue
  • spark
  • geomesa
ExpireTime String 2019-10-12T14:40:46

失效时间。

InstanceName String test

集群名称,您可以自定义,建议统一使用ClusterName。

ExpireTimeUTC String 2019-10-12T14:40:46Z

失效时间,UTC格式。

InstanceId String ld-uf699153o1m2l-m****

集群ID,系统生成的唯一标识码,兼容老客户,等于ClusterId,建议统一使用ClusterId。

IsHa Boolean true

是否高可用,返回值:

  • true:高可用。
  • false:非高可用。
IsLatestVersion Boolean true

是否为最新版本,返回值:

  • true:最新版本。
  • false:不是最新版本。
IsMultiModel Boolean true

是否为多模,返回值:

  • true:是多模。
  • false:不是多模。
MaintainEndTime String 22:00Z

实例运维结束时间。

MaintainStartTime String 18:00Z

实例运维开始时间。

MajorVersion String 2.0

主版本号。

MasterDiskSize Integer 0

主节点磁盘大小,默认单位G。

MasterDiskType String cloud_efficiency

主节点磁盘类型。

  • cloud_efficiency:高效云盘。
  • cloud_ssd:ssd云盘。
MasterInstanceType String hbase.sn2.large

主节点实例类型。

MasterNodeCount Integer 2

表示主节点个数,返回值:

  • 0表示主节点个数为单节点。
  • 2表示主节点为高可用。
MinorVersion String 7.7.6

小版本号。

NetworkType String VPC

网络类型。

  • VPC:VPC网络类型,如果为VPC网络,就会返回vSwitchId和vpcId。
  • CLASSIC:经典网络类型。
PayType String Postpaid

付费类型。

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

实例所属地域ID。

RequestId String B1CFC73D-0EEE-436A-B694-5BEF3450****

RequestId自动生成的唯一请求标识码。

Status String ACTIVATION

集群状态。

  • CREATING:创建中。
  • ACTIVATION:运行中。
  • DELETING:删除中。
  • RESTARTING:重启中。
Tags Array of Tag

资源标签。

Tag
Key String test_key

标签Key值。

Value String test_value

标签Value值。

VpcId String vpc-uf69ptnt4ku64****

专有网络vpcId,当NetworkType为2时会返回vpcId。

VswitchId String vsw-uf6vlkwlqqsu3****

虚拟交换机Id,当NetworkType为2时会返回虚拟交换机Id。

ZoneId String cn-shanghai-b

实例所属可用区ID。

IsDeletionProtection Boolean false

是否开启删除保护。

ModuleId Integer 1

模块ID。

ModuleStackVersion String 5.0

模块堆栈版本。

ParentId String ld-uf699153o1m2l****

父实例ID。

AutoRenewal Boolean true

是否自动续费。返回值:

  • true:自动续费。
  • false:不自动续费。
说明 后付费实例没有此返回值。
ColdStorageSize Integer 800

冷存储空间大小。

Duration Integer 12

自动续费周期。

  • 按月购买:则自动续费周期为1个月。
  • 按年购买:则自动续费周期为1年(12个月)。
说明 后付费实例没有此返回值。
EncryptionKey String 2a****

加密的密钥ID,如果未启用加密则为空。

说明 加密类型为NoEncryption时不返回此参数。
EncryptionType String NoEncryption

加密类型,可选项为:

  • NoEncryption:不启用加密。
  • CloudDisk:云盘加密并返回EncryptionKey参数指定加密的密钥。
说明 当前云盘加密开启后无法关闭。
ResourceGroupId String rg-****

资源所在的资源组ID。

示例

请求示例

http(s)://hbase.aliyuncs.com/?Action=DescribeInstance
&ClusterId=ld-uf699153o1m2l-m****
&<公共请求参数>

正常返回示例

XML格式

<DescribeInstanceResponse>
  <ModuleStackVersion>5.0</ModuleStackVersion>
  <CreatedTime>2020-07-20T20:28:12</CreatedTime>
  <MasterInstanceType>hbase.sn2.large</MasterInstanceType>
  <IsDeletionProtection>false</IsDeletionProtection>
  <IsLatestVersion>true</IsLatestVersion>
  <ModuleId>1</ModuleId>
  <MaintainEndTime>22:00Z</MaintainEndTime>
  <NetworkType>VPC</NetworkType>
  <CoreInstanceType>hbase.sn2.2xlarge</CoreInstanceType>
  <ClusterName>ld-uf699153o1m2l-m****</ClusterName>
  <MasterDiskType></MasterDiskType>
  <Engine>hbaseue</Engine>
  <MaintainStartTime>18:00Z</MaintainStartTime>
  <Tags>
</Tags>
  <Status>ACTIVATION</Status>
  <MajorVersion>2.0</MajorVersion>
  <CoreDiskCount>4</CoreDiskCount>
  <ParentId>ld-uf699153o1m2l****</ParentId>
  <MasterDiskSize>0</MasterDiskSize>
  <RequestId>B1CFC73D-0EEE-436A-B694-5BEF3450****</RequestId>
  <ZoneId>cn-shanghai-b</ZoneId>
  <InstanceId>ld-uf699153o1m2l-m****</InstanceId>
  <CoreNodeCount>2</CoreNodeCount>
  <ClusterId>ld-uf699153o1m2l-m****</ClusterId>
  <ColdStorageStatus>open</ColdStorageStatus>
  <MinorVersion>7.7.6</MinorVersion>
  <CreatedTimeUTC>2020-07-20T12:28:12Z</CreatedTimeUTC>
  <PayType>Postpaid</PayType>
  <IsMultiModel>true</IsMultiModel>
  <ClusterType>cluster</ClusterType>
  <VswitchId>vsw-uf6vlkwlqqsu3****</VswitchId>
  <InstanceName>ld-uf699153o1m2l-m****</InstanceName>
  <MasterNodeCount>2</MasterNodeCount>
  <VpcId>vpc-uf69ptnt4ku648oi4****</VpcId>
  <CoreDiskType>cloud_ssd</CoreDiskType>
  <RegionId>cn-shanghai</RegionId>
  <CoreDiskSize>100</CoreDiskSize>
  <BackupStatus>open</BackupStatus>
  <IsHa>true</IsHa>
  <ResourceGroupId>rg-****</ResourceGroupId>
</DescribeInstanceResponse>

JSON格式

{
    "ModuleStackVersion": "5.0",
    "CreatedTime": "2020-07-20T20:28:12",
    "MasterInstanceType": "hbase.sn2.large",
    "IsDeletionProtection": false,
    "IsLatestVersion": true,
    "ModuleId": 1,
    "MaintainEndTime": "22:00Z",
    "NetworkType": "VPC",
    "CoreInstanceType": "hbase.sn2.2xlarge",
    "ClusterName": "ld-uf699153o1m2l-m****",
    "MasterDiskType": "",
    "Engine": "hbaseue",
    "MaintainStartTime": "18:00Z",
    "Tags": {
        "Tag": []
    },
    "Status": "ACTIVATION",
    "MajorVersion": "2.0",
    "CoreDiskCount": 4,
    "ParentId": "ld-uf699153o1m2l****",
    "MasterDiskSize": 0,
    "RequestId": "B1CFC73D-0EEE-436A-B694-5BEF3450****",
    "ZoneId": "cn-shanghai-b",
    "InstanceId": "ld-uf699153o1m2l-m****",
    "CoreNodeCount": 2,
    "ClusterId": "ld-uf699153o1m2l-m****",
    "ColdStorageStatus": "open",
    "MinorVersion": "7.7.6",
    "CreatedTimeUTC": "2020-07-20T12:28:12Z",
    "PayType": "Postpaid",
    "IsMultiModel": true,
    "ClusterType": "cluster",
    "VswitchId": "vsw-uf6vlkwlqqsu3****",
    "InstanceName": "ld-uf699153o1m2l-m****",
    "MasterNodeCount": 2,
    "VpcId": "vpc-uf69ptnt4ku648oi4****",
    "CoreDiskType": "cloud_ssd",
    "RegionId": "cn-shanghai",
    "CoreDiskSize": 100,
    "BackupStatus": "open",
    "IsHa": true,
    "ResourceGroupId": "rg-****"
}

错误码

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