DescribeInstance - ApsaraDB for HBase - Alibaba Cloud Documentation Center

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeInstance	The operation that you want to perform. Set the value to DescribeInstance.
ClusterId	String	Yes	ld-bp150tns0sjxs****	The ID of the instance that you want to query.

Response parameters


Parameter	Type	Example	Description
BackupStatus	String	open	Indicates whether the backup feature is enabled for the instance. open: The backup feature is enabled for the instance. close: The backup feature is disabled for the instance.
ClusterId	String	ld-bp150tns0sjxs****	The ID of the instance.
ClusterName	String	testhbase	The name of the instance.
ClusterType	String	cluster	The type of the instance. Valid values: cluster: The instance is a cluster instance. single: The instance is a standalone instance.
ColdStorageStatus	String	open	Indicates whether the cold storage feature is enabled for the instance. Valid values: open: The cold storage feature is enabled for the instance. close: The cold storage feature is disabled for the instance.
CoreDiskCount	String	4	The number of disks of each core node.
CoreDiskSize	Integer	100	The disk capacity of each core node. Unit: GB.
CoreDiskType	String	cloud_ssd	The disk type of the core nodes. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD local_hdd: local HDD local__ssd: local SSD
CoreInstanceType	String	hbase.sn2.2xlarge	The instance type of the core nodes.
CoreNodeCount	Integer	2	The number of core nodes.
CreatedTime	String	2021-07-19T11:23:22	The point in time when the instance was created.
CreatedTimeUTC	String	2021-07-19T03:23:22Z	The point in time when the instance was created. The time is displayed in UTC.
Engine	String	hbaseue	The edition of the instance. Valid values: hbase: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase Standalone Edition hbaseue: ApsaraDB for HBase Performance-enhanced Edition serverlesshbase: ApsaraDB for HBase Serverless Edition bds: BDS Edition that uses Lindorm Tunnel Service (LTS)
ExpireTime	String	2022-02-24T00:00:00	The point in time when the instance expires.
InstanceName	String	testhbase	The name of the instance.
ExpireTimeUTC	String	2022-02-23T16:00:00Z	The point in time when the instance expires. The time is displayed in UTC.
InstanceId	String	ld-bp150tns0sjxs****	The ID of the instance.
IsHa	Boolean	true	Indicates whether the instance is highly available. Valid values: true: The instance is highly available. false: The instance is not highly available. Note By default, if the instance is a cluster instance, the instance contains two master nodes to ensure high availability. If the instance is a standalone instance, the instance contains one node. In this case, the storage capacity of the instance equals the storage capacity of the disk that is mounted to the node.
IsLatestVersion	Boolean	true	Indicates whether the version of the instance is the latest. Valid values: true: The version of the instance is the latest. false: The version of the instance is not the latest.
IsMultiModel	Boolean	true	Indicates whether the instance is a cluster instance that supports multiple data models. true: The instance is a cluster instance that supports multiple data models. false: The instance is not a cluster instance that supports multiple data models.
MaintainEndTime	String	22:00Z	The end time of the maintenance window of the instance.
MaintainStartTime	String	18:00Z	The start time of the maintenance window of the instance.
MajorVersion	String	2.0	The major version.
MasterDiskSize	Integer	0	The disk capacity of the master node. Unit: GB.
MasterDiskType	String	cloud_efficiency	The disk type of the master node. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD Note This parameter is returned only when the instance is a standalone instance.
MasterInstanceType	String	hbase.sn2.large	The instance type of the master nodes.
MasterNodeCount	Integer	2	Indicates the category of the master node. Valid values: 0: standalone node 2: cluster node
MinorVersion	String	2.2.9.1	The minor version of the instance.
NetworkType	String	VPC	The network type of the instance. Valid values: VPC: virtual private cloud (VPC). If the network type is VPC, the VswitchId parameter and VpcId parameter are returned. CLASSIC: classic network
PayType	String	Prepaid	The billing method of the instance. Valid values: Prepaid: subscription Postpaid: pay-as-you-go
RegionId	String	cn-hangzhou	The ID of the region where the instance is deployed.
RequestId	String	3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66	The ID of the request.
Status	String	ACTIVATION	The status of the instance. Valid values: CREATING: The instance is being created. ACTIVATION: The instance is running. DELETING: The instance is being deleted. RESTARTING: The instance is restarting. MINOR_VERSION_TRANSING: The minor version of the instance is being updated.
Tags	Array of Tag		The tags of the instance.
Tag
Key	String	test_key	The key of the tag.
Value	String	test_value	The value of the tag.
VpcId	String	vpc-bp15s22y1a7sff5gj****	The ID of the VPC. This parameter is returned only when the value of the NetworkType parameter is set to 2.
VswitchId	String	vsw-bp1foll427ze3d4ps****	The ID of the vSwitch. This parameter is returned only when the value of the NetworkType parameter is set to 2.
ZoneId	String	cn-hangzhou-f	The ID of the zone where the instance is deployed.
IsDeletionProtection	Boolean	false	Indicates whether the deletion protection feature is enabled for the instance. Valid values: true: The deletion protection feature is enabled for the instance. false: The deletion protection feature is disabled for the instance.
ModuleId	Integer	0	The ID of the module.
ModuleStackVersion	String	phoenxi:4.0	The version of the module.
ParentId	String	ld-uf699153o1m2l****	The ID of the parent instance.
AutoRenewal	Boolean	false	Indicates whether the auto-renewal feature is enabled for the instance. Valid values: true: The auto-renewal feature is enabled for the instance. false: The auto-renewal feature is disabled for the instance. Note This parameter is not returned if the instance uses the pay-as-you-go billing method.
ColdStorageSize	Integer	800	The storage space for cold data.
ConfirmMaintainTime	String	true	Specifies whether the maintenance window of the instance is confirmed. Return values: true: The maintenance window of the instance is confirmed. false: The maintenance window of the instance is not confirmed. Note The Confirm Maintenance Window dialog box appears only the first time you open the Basic Information page of your instance.
Duration	Integer	12	The auto-renewal cycle of the instance. Monthly subscription: The auto-renewal cycle is one month. Annual subscription: The auto-renewal cycle is one year (12 months). Note This parameter is not returned if the instance uses the pay-as-you-go billing method.
EncryptionKey	String	0d2470df-da7b-4786-b981-9a164dae****	The cryptographic key. Note This parameter is returned when the value of the EncryptionType parameter is CloudDisk.
EncryptionType	String	NoEncryption	The encryption type. Valid values: NoEncryption: The data encryption feature is not enabled. CloudDisk: The data encryption feature is enabled for disks. In this case, the EncryptionKey parameter is returned. Note You cannot disable the disk encryption feature after you enable it.
NeedUpgrade	Boolean	false	Indicates whether the components of the instance can be upgraded. Valid values: true: The components can be upgraded. false: The components cannot be upgraded.
NeedUpgradeComps	List	[lindorm, hdfs]	Indicates the names of the components that can be upgraded. Note This parameter is returned only when the value of the NeedUpgrade parameter is true.
ResourceGroupId	String	rg-acfmyiu4ekp****	The ID of the resource group that contains the instance.
TaskProgress	String	25.00	The progress of the task that is running on the instance. Unit: percentage. In the ApsaraDB for HBase console, you can initiate a task such as changing specifications, scaling out nodes for the instance, scaling in nodes for the instance, restarting the instance, or upgrading the minor version of the instance.

Examples

Sample requests

http(s)://hbase.aliyuncs.com/?Action=DescribeInstance
&ClusterId=ld-bp150tns0sjxs****
&<Common request parameters>

Sample success responses

XML format

<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></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 format

{
    "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
}

Error codes

For a list of error codes, visit the API Error Center.