Queries the basic information about a cluster by using the cluster ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstance

The operation that you want to perform.

ClusterId String Yes ld-uf699153o1m2l-m****

The ID of the cluster.

Response parameters

Parameter Type Example Description
BackupStatus String open

The backup and restoration status. Valid values:

  • open: The backup and restoration status is displayed.
  • close: The backup and restoration status is not displayed.
ClusterId String ld-uf699153o1m2l-m****

The ID of the cluster. The cluster ID is a unique identifier generated by the system. The value of this parameter is the same as that of the InstanceId parameter. We recommend that you use the value of the ClusterId parameter.

ClusterName String test

The name of the cluster. The value of this parameter is the same as that of the InstanceName parameter. We recommend that you use the value of the ClusterName parameter.

ClusterType String cluster

The type of the cluster. Valid values:

  • cluster
  • single
ColdStorageStatus String open

The status of hot and cold data separation. Valid values:

  • open: The page for cold and hot data separation is available.
  • close: The page for cold and hot data separation is unavailable.
CoreDiskCount String 4

The number of disks for the core node.

CoreDiskSize Integer 100

The disk size of the core node. Unit: GB.

CoreDiskType String cloud_ssd

The disk type of the core node. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
CoreInstanceType String hbase.sn2.2xlarge

The cluster type of the core node.

CoreNodeCount Integer 2

The number of core nodes.

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

The time when the cluster was created.

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

The time when the cluster was created. The time is displayed in UTC.

Engine String hbaseue

The engine type.

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

The time when the cluster expires.

InstanceName String test

The name of the cluster. We recommend that you use the value of the ClusterName parameter.

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

The time when the cluster expires. The time is displayed in UTC.

InstanceId String ld-uf699153o1m2l-m****

The ID of the cluster. The cluster ID is a unique identifier generated by the system. The parameter is used to ensure backward compatibility. The value of this parameter is the same as the value of the ClusterId parameter. We recommend that you use the value of the ClusterId parameter.

IsHa Boolean true

Indicates whether the cluster is a high-availability cluster. Valid values:

  • true: The cluster is a high-availability cluster.
  • false: The cluster is not a high-availability cluster.
IsLatestVersion Boolean true

Indicates whether the version is the latest version. Valid values:

  • true: The version is the latest version.
  • false: The version is not the latest version.
IsMultiModel Boolean true

Indicates whether the cluster can process multi-model data.

  • true: The cluster can process multi-model data.
  • false: The cluster cannot process multi-model data.
MaintainEndTime String 22:00Z

The end time of the maintenance window of the cluster.

MaintainStartTime String 18:00Z

The start time of the maintenance window of the cluster.

MajorVersion String 2.0

The major version number.

MasterDiskSize Integer 0

The disk size of the master node. Unit: GB.

MasterDiskType String cloud_efficiency

The disk type of the master node.

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
MasterInstanceType String hbase.sn2.large

The cluster type of the master node.

MasterNodeCount Integer 2

The number of master nodes. Valid values:

  • 0: Only one master node is used in the cluster.
  • 2: Two master nodes are used in the cluster to ensure high availability.
MinorVersion String 7.7.6

The minor version number.

NetworkType String VPC

The type of the network.

  • VPC: the virtual private cloud (VPC) network type. If the VPC network type is used, the values of the vSwitchId parameter and vpcId parameter are returned.
  • CLASSIC: the classic network.
PayType String Postpaid

The billing method.

  • Prepaid: The subscription billing method is used.
  • Postpaid: The pay-as-you-go billing method is used.
RegionId String cn-shanghai

The ID of the region where the cluster is deployed.

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

The ID of the request. The request ID is a unique identifier automatically generated for the request.

Status String ACTIVATION

The status of the cluster.

  • CREATING: The cluster is being created.
  • ACTIVATION: The cluster is running.
  • DELETING: The cluster is being deleted.
  • RESTARTING: The cluster is restarting.
Tags Array of Tag

The resource tags.

Tag
Key String test_key

The key of the tag.

Value String test_value

The value of the tag.

VpcId String vpc-uf69ptnt4ku64****

The ID of the VPC. If the value of the NetworkType parameter is VPC, the ID of the VPC is returned.

VswitchId String vsw-uf6vlkwlqqsu3****

The ID of the vSwitch. If the value of the NetworkType parameter is VPC, the ID of the vSwitch is returned.

ZoneId String cn-shanghai-b

The ID of the zone where the cluster is deployed.

IsDeletionProtection Boolean false

Indicates whether deletion protection is enabled.

ModuleId Integer 1

The ID of the module.

ModuleStackVersion String 5.0

The version of the module stack.

ParentId String ld-uf699153o1m2l****

The ID of the parent cluster.

AutoRenewal Boolean true

Indicates whether auto-renewal is enabled. Valid values:

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
Note This parameter is not returned for pay-as-you-go clusters.
ColdStorageSize Integer 800

The size of the cold storage space.

Duration Integer 12

The auto-renewal period.

  • Monthly subscription: The auto-renewal period is one month.
  • Annual subscription: The auto-renewal period is one year (12 months).
Note This parameter is not returned for pay-as-you-go clusters.
EncryptionKey String 2a****

The ID of the encryption key. If encryption is disabled, this parameter is not returned.

Note This parameter is not returned if the value of the EncryptionType parameter is NoEncryption.
EncryptionType String NoEncryption

The encryption type. Valid values:

  • NoEncryption: Encryption is disabled.
  • CloudDisk: Encryption is enabled for disks. The encryption key indicated by the EncryptionKey parameter is returned.
Note Disk encryption cannot be disabled after it is enabled.
ResourceGroupId String rg-****

The ID of the resource group to which the cluster resources belong.

Examples

Sample requests

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

Sample success responses

XML format 

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

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

Error codes

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