DescribeInstance - 云数据库 HBase

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstance	系统规定参数，取值：DescribeInstance。
ClusterId	String	是	ld-bp150tns0sjxs****	实例ID，可调用DescribeInstances接口获取。

返回数据

名称	类型	示例值	描述
VpcId	String	vpc-bp15s22y1a7sff5gj****	专有网络ID，当NetworkType为2时会返回此参数。
Status	String	ACTIVATION	实例状态，返回值： CREATING：创建中。 ACTIVATION：运行中。 DELETING：删除中。 RESTARTING：重启中。 MINOR_VERSION_TRANSING：小版本升级中。
EncryptionType	String	NoEncryption	加密类型，返回值： NoEncryption：不启用加密。 CloudDisk：云盘加密并返回。 EncryptionKey：参数指定加密的密钥。说明云盘加密开启后无法关闭。
ModuleId	Integer	0	模块ID。
VswitchId	String	vsw-bp1foll427ze3d4ps****	虚拟交换机ID，当NetworkType为2时会返回此参数。
BackupStatus	String	open	表示是否支持备份功能，返回值： open：支持备份功能。 close：不支持备份功能。
PayType	String	Prepaid	实例的计费类型，返回值： Prepaid：包年包月。 Postpaid：按量付费。
CoreDiskType	String	cloud_ssd	Core节点磁盘类型，返回值： cloud_efficiency：高效云盘。 cloud_ssd：SSD云盘。 local_hdd：本地HDD盘。 local__ssd：本地SSD盘。
MasterNodeCount	Integer	2	表示Master节点类型，返回值： 0表示Master节点为单节点。 2表示Master节点为集群版。
NetworkType	String	VPC	网络类型，返回值： VPC：专有网络类型，如果为专有网络，则返回VswitchId和VpcId参数。 CLASSIC：经典网络类型。
CreatedTimeUTC	String	2021-07-19T03:23:22Z	实例创建时间，UTC格式。
ColdStorageSize	Integer	800	冷存储空间大小，单位为GB。
ParentId	String	ld-uf699153o1m2l****	父实例ID。
IsLatestVersion	Boolean	true	实例是否为最新版本，返回值： true：最新版本。 false：不是最新版本。
ExpireTimeUTC	String	2022-02-23T16:00:00Z	实例到期时间，UTC格式。
RequestId	String	3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66	请求ID。
InstanceName	String	testhbase	实例名称。
MasterInstanceType	String	hbase.sn2.large	Master节点规格。
CoreInstanceType	String	hbase.sn2.2xlarge	Core节点规格。
EncryptionKey	String	0d2470df-da7b-4786-b981-9a164dae****	加密的密钥。说明加密类型为CloudDisk时返回此参数。
CreatedTime	String	2021-07-19T11:23:22	实例创建时间。
CoreDiskSize	Integer	100	Core节点磁盘容量，单位为GB。
ClusterId	String	ld-bp150tns0sjxs****	实例ID。
ExpireTime	String	2022-02-24T00:00:00	实例到期时间。
MaintainStartTime	String	18:00Z	实例运维开始时间。
ConfirmMaintainTime	String	true	是否首次确认实例的运维时间，返回值： true：已确认。 false：未确认。说明仅首次进入实例的基本信息页面会弹出首次确认实例的运维时间对话框。
IsHa	Boolean	true	实例是否配置为高可用，返回值： true：配置为高可用。 false：未配置为高可用。说明集群版默认配置为高可用，使用2个Master节点。单节点配置为实际可用容量。
MaintainEndTime	String	22:00Z	实例运维结束时间。
InstanceId	String	ld-bp150tns0sjxs****	实例ID。
ColdStorageStatus	String	open	是否支持冷存储功能，返回值： open：支持冷存储功能。 close：不支持冷存储功能。
IsDeletionProtection	Boolean	false	是否开启删除保护，返回值： true：开启。 false：未开启。
MinorVersion	String	2.2.9.1	实例的小版本号。
RegionId	String	cn-hangzhou	实例所属地域的ID。
MasterDiskSize	Integer	0	Master节点的磁盘容量，单位为GB。
MasterDiskType	String	cloud_efficiency	Master节点的磁盘类型，返回值： cloud_efficiency：高效云盘。 cloud_ssd：SSD云盘。说明单节点实例会返回此参数。
NeedUpgrade	Boolean	false	表示是否需要升级实例的组件，返回值： true：升级。 false：不升级。
IsMultiModel	Boolean	true	实例是否为多模集群版，返回值： true：是多模集群版。 false：不是多模集群版。
AutoRenewal	Boolean	false	实例是否自动续费，返回值： true：自动续费。 false：不自动续费。说明仅当PayType取值为Prepaid（包年包月）时，此参数有返回值。
ClusterType	String	cluster	实例类型，返回值： cluster：集群版。 single：单节点。
ResourceGroupId	String	rg-acfmyiu4ekp****	资源组ID。
ClusterName	String	testhbase	实例名称。
ZoneId	String	cn-hangzhou-f	可用区ID。
Duration	Integer	12	自动续费周期。按月购买：自动续费周期为1个月。按年购买：自动续费周期为1年（12个月）。说明仅当PayType取值为Prepaid（包年包月）时，此参数有返回值。
ModuleStackVersion	String	phoenxi:4.0	模块类型版本。
Engine	String	hbaseue	数据引擎类型。 hbase：HBase标准版或HBase单机版。 hbaseue：HBase增强版。 serverlesshbase：HBaseServerless版。 bds：BDS实例。
MajorVersion	String	2.0	主版本号。
CoreDiskCount	String	4	Core磁盘数量。
TaskProgress	String	25.00	实例的任务运行进度，单位为百分比（%）。通过云数据库HBase控制台发起的任务，包括变更规格、扩容节点、缩容节点、重启实例，小版本升级等。
CoreNodeCount	Integer	2	Core节点个数。
EnableHbaseProxy	Boolean	false	是否支持HBase开源客户端访问，返回值： true：支持访问。 false：不支持访问。
LproxyMinorVersion	String	2.3.2	LPROXY服务的最小版本。
NeedUpgradeComps	Array of String	[lindorm, hdfs]	需要升级的组件名称。说明当NeedUpgrade参数返回true时，则返回此参数。
Tags	Array of Tag		资源标签。
Tag
Key	String	test_key	标签Key值。
Value	String	test_value	标签Value值。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceResponse>
<CreatedTime>2021-07-19T11:23:22</CreatedTime>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<NeedUpgrade>false</NeedUpgrade>
<ModuleId>0</ModuleId>
<Engine>hbaseue</Engine>
<NeedUpgradeComps>
</NeedUpgradeComps>
<Tags>
</Tags>
<Status>ACTIVATION</Status>
<ColdStorageSize>800</ColdStorageSize>
<EncryptionType>NoEncryption</EncryptionType>
<MasterDiskSize>0</MasterDiskSize>
<ExpireTimeUTC>2022-02-23T16:00:00Z</ExpireTimeUTC>
<RequestId>3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66</RequestId>
<InstanceId>ld-bp150tns0sjxs****</InstanceId>
<PayType>Prepaid</PayType>
<VswitchId>vsw-bp1foll427ze3d4ps****</VswitchId>
<InstanceName>testhbase</InstanceName>
<MasterNodeCount>2</MasterNodeCount>
<VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>
<AutoRenewal>false</AutoRenewal>
<CoreDiskType>cloud_ssd</CoreDiskType>
<ExpireTime>2022-02-24T00:00:00</ExpireTime>
<BackupStatus>open</BackupStatus>
<IsHa>true</IsHa>
<TaskProgress>25.00</TaskProgress>
<MasterInstanceType>hbase.sn1.2xlarge</MasterInstanceType>
<IsDeletionProtection>false</IsDeletionProtection>
<IsLatestVersion>true</IsLatestVersion>
<MaintainEndTime>22:00Z</MaintainEndTime>
<NetworkType>VPC</NetworkType>
<CoreInstanceType>hbase.sn2.2xlarge</CoreInstanceType>
<ClusterName>testhbase</ClusterName>
<MasterDiskType/>
<MaintainStartTime>18:00Z</MaintainStartTime>
<MajorVersion>2.0</MajorVersion>
<CoreDiskCount>4</CoreDiskCount>
<ZoneId>cn-hangzhou-f</ZoneId>
<CoreNodeCount>2</CoreNodeCount>
<ClusterId>ld-bp150tns0sjxs****</ClusterId>
<ColdStorageStatus>open</ColdStorageStatus>
<MinorVersion>2.2.9.1</MinorVersion>
<CreatedTimeUTC>2021-07-19T03:23:22Z</CreatedTimeUTC>
<IsMultiModel>true</IsMultiModel>
<ClusterType>cluster</ClusterType>
<RegionId>cn-hangzhou</RegionId>
<CoreDiskSize>100</CoreDiskSize>
<ConfirmMaintainTime>true</ConfirmMaintainTime>
</DescribeInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CreatedTime" : "2021-07-19T11:23:22",
  "ResourceGroupId" : "rg-acfmyiu4ekp****",
  "NeedUpgrade" : false,
  "ModuleId" : 0,
  "Engine" : "hbaseue",
  "NeedUpgradeComps" : {
    "Comps" : [ ]
  },
  "Tags" : {
    "Tag" : [ ]
  },
  "Status" : "ACTIVATION",
  "ColdStorageSize" : 800,
  "EncryptionType" : "NoEncryption",
  "MasterDiskSize" : 0,
  "ExpireTimeUTC" : "2022-02-23T16:00:00Z",
  "RequestId" : "3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66",
  "InstanceId" : "ld-bp150tns0sjxs****",
  "PayType" : "Prepaid",
  "VswitchId" : "vsw-bp1foll427ze3d4ps****",
  "InstanceName" : "testhbase",
  "MasterNodeCount" : 2,
  "VpcId" : "vpc-bp15s22y1a7sff5gj****",
  "AutoRenewal" : false,
  "CoreDiskType" : "cloud_ssd",
  "ExpireTime" : "2022-02-24T00:00:00",
  "BackupStatus" : "open",
  "IsHa" : true,
  "TaskProgress" : "25.00",
  "MasterInstanceType" : "hbase.sn1.2xlarge",
  "IsDeletionProtection" : false,
  "IsLatestVersion" : true,
  "MaintainEndTime" : "22:00Z",
  "NetworkType" : "VPC",
  "CoreInstanceType" : "hbase.sn2.2xlarge",
  "ClusterName" : "testhbase",
  "MasterDiskType" : "",
  "MaintainStartTime" : "18:00Z",
  "MajorVersion" : "2.0",
  "CoreDiskCount" : 4,
  "ZoneId" : "cn-hangzhou-f",
  "CoreNodeCount" : 2,
  "ClusterId" : "ld-bp150tns0sjxs****",
  "ColdStorageStatus" : "open",
  "MinorVersion" : "2.2.9.1",
  "CreatedTimeUTC" : "2021-07-19T03:23:22Z",
  "IsMultiModel" : true,
  "ClusterType" : "cluster",
  "RegionId" : "cn-hangzhou",
  "ConfirmMaintainTime" : true,
  "CoreDiskSize" : 100
}

错误码

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