Query the basic information of a cluster based on the cluster id.
Debugging
Request parameters
Prameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeInstance |
Required. Set the value to DescribeInstance. |
ClusterId | String | Yes | hb-bp16f1441y6p2kv** |
The ID of the cluster that you want to query. |
Response parameters
Field | Type | Sample response | Description |
---|---|---|---|
BackupStatus | String | open |
Indicates 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 | hb-bp16f1441y6p2kv** |
The cluster ID, which is the unique identifier generated by the system. Is equal to InstanceId. We recommend that you use ClusterId in a unified manner. |
ClusterName | String | test |
The name of the cluster, which is equal to InstanceName. We recommend that you use ClusterName uniformly. |
ClusterType | String | cluster |
The type of the cluster. Set the value to cluster/single. |
ColdStorageStatus | String | open |
Indicates whether cold data and hot data are stored separately. Valid values: open: Cold data and hot data are stored separately. close: Cold data and hot data are not stored separately. |
CoreDiskCount | String | 2 |
The number of disks for the core node. |
CoreDiskSize | Integer | 100 |
The disk size of the core node. Unit: GB. |
CoreDiskType | String | cloud_efficiency |
The disk type of the core node. Valid values: cloud_efficiency cloud_ssd |
CoreInstanceType | String | hbase.sn1.large |
The instance type of the core node. |
CoreNodeCount | Integer | 2 |
The number of core nodes. |
CreatedTime | String | 2019-09-12T14:40:46 |
The time when the cluster was created. |
CreatedTimeUTC | String | 2019-09-12T14:40:46Z |
Creation time, in UTC format |
Engine | String | hbase |
The product engine. hbase spark geomesa ... |
ExpireTime | String | 2019-10-12T14:40:46 |
The expiration time. |
InstanceName | String | openapi-test |
The cluster name, which can be set by the user. It equals to ClusterName. We recommend that you use ClusterName in all scenarios. |
ExpireTimeUTC | String | 2019-10-12T14:40:46Z |
The expiration time, in UTC format. |
InstanceId | String | hb-bp16f1441y6p2kv** |
Cluster ID, which is the unique identification code generated by the system. It is compatible with old customers and equals to ClusterId. We recommend that you use ClusterId in a unified manner. |
IsHa | Boolean | true |
Indicates whether the cluster is highly available. true/false |
IsLatestVersion | Boolean | true |
true/false latest version |
IsMultiModel | Boolean | true |
true/false, whether it is multimodal |
MaintainEndTime | String | 4:00 |
The end time of the maintenance window of the instance. |
MaintainStartTime | String | 2:00 |
The start time of the maintenance window of the instance. |
MajorVersion | String | 2.0 |
The major version number. |
MasterDiskSize | Integer | 100 |
The disk size of the master node. Unit: GB. |
MasterDiskType | String | cloud_efficiency |
The disk type of the master node. Valid values: cloud_efficiency cloud_ssd |
MasterInstanceType | String | hbase.sn1.large |
The instance type of the master node. |
MasterNodeCount | Integer | 2 |
The number of master nodes. If the master node is a single node, the returned value is 0. If the master node is a high availability node, the returned value is 2. |
MinorVersion | String | 2.0.8 |
The minor version number. |
NetworkType | String | VPC |
The type of the network. Valid values: VPC CLASSIC If the network type is VPC, the values of vSwitchId and vpcId are returned. |
PayType | String | Postpaid |
The billing method of the cluster. Valid values:
|
RegionId | String | cn-shanghai |
The region ID of the instance. |
RequestId | String | EBECBF12-2E34-41BE-8DE9-FC3700D4D6** |
The ID of the request. It is the unique ID that is dynamically generated for the request. |
Status | String | ACTIVATION |
The status of a cluster. Valid values: CREATING ACTIVATION DELETING RESTARTING |
Tags | Array of Tag |
The tags of the resource. |
|
Tag | |||
Key | String | test_key |
The key of the tag. |
Value | String | test_value |
The value of the tag. |
VpcId | String | vpc-bp120k6ixs4eoghz***** |
The ID of the VPC. When the value of NetworkType is VPC, this value is returned. Example: vpc-xxxx. |
VswitchId | String | vsw-bp191ipotq****dbqf |
The ID of the VSwitch. When the value of NetworkType is VPC, this value is returned. Example: vsw-xxxx. |
ZoneId | String | cn-hangzhou-f |
The zone ID of the instance. |
IsDeletionProtection | Boolean | true |
Whether to enable deletion protection |
ModuleId | Integer | 1 |
The module ID. |
ModuleStackVersion | String | 5.0 |
Module stack version |
ParentId | String | ld-uf699153o****1m2l |
The ID of the parent instance. |
AutoRenewal | Boolean | true |
Indicates whether auto-renewal is enabled. Valid values: true/false Note Postpaid instances do not have this return value
|
ColdStorageSize | Integer | 800 |
The size of the cold storage space. |
Duration | Integer | 12 |
The auto-renewal period for the created ECS instances.
Note Postpaid instances do not have this return value
|
ResourceGroupId | String | rg-xxxxxxxxxxx |
The Id of the resource group to which the resource belongs. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeInstance &ClusterId=hb-bp16f1441y6p2kv ** &<common request parameters>
Sample success responses
XML
format
<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-uf699153o*****1m2l-m1-se</ClusterName> <MasterDiskType/> <Engine>hbaseue</Engine> <MaintainStartTime>18:00Z</MaintainStartTime> <Tags> </Tags> <Status>ACTIVATION</Status> <MajorVersion>2.0</MajorVersion> <CoreDiskCount>4</CoreDiskCount> <ParentId>ld-uf699153o****1m2l</ParentId> <MasterDiskSize>0</MasterDiskSize> <RequestId>B1CFC73D-0EEE-436A-B694-5BEF3450ECF7</RequestId> <ZoneId>cn-shanghai-b</ZoneId> <InstanceId>ld-uf699153o****1m2l-m1-se</InstanceId> <CoreNodeCount>2</CoreNodeCount> <ClusterId>ld-uf699153o****1m2l-m1-se</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****pwzj</VswitchId> <InstanceName>ld-uf699153o****1m2l-m1-se</InstanceName> <MasterNodeCount>2</MasterNodeCount> <VpcId>vpc-uf69ptnt4ku64****8oi4</VpcId> <CoreDiskType>cloud_ssd</CoreDiskType> <RegionId>cn-shanghai</RegionId> <CoreDiskSize>100</CoreDiskSize> <BackupStatus>open</BackupStatus> <IsHa>true</IsHa> <ResourceGroupId>rg-xxxxxxxxxxx</ResourceGroupId>
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-uf699153o*****1m2l-m1-se", "MasterDiskType": "", "Engine": "hbaseue", "MaintainStartTime": "18:00Z", "Tags": { "Tag": [] }, "Status": "ACTIVATION", "MajorVersion": "2.0", "CoreDiskCount": 4, "ParentId": "ld-uf699153o****1m2l", "MasterDiskSize": 0, "RequestId": "B1CFC73D-0EEE-436A-B694-5BEF3450ECF7", "ZoneId": "cn-shanghai-b", "InstanceId": "ld-uf699153o****1m2l-m1-se", "CoreNodeCount": 2, "ClusterId": "ld-uf699153o****1m2l-m1-se", "ColdStorageStatus": "open", "MinorVersion": "7.7.6", "CreatedTimeUTC": "2020-07-20T12:28:12Z", "PayType": "Postpaid", "IsMultiModel": true, "ClusterType": "cluster", "VswitchId": "vsw-uf6vlkwlqqsu3****pwzj", "InstanceName": "ld-uf699153o****1m2l-m1-se", "MasterNodeCount": 2, "VpcId": "vpc-uf69ptnt4ku64****8oi4", "CoreDiskType": "cloud_ssd", "RegionId": "cn-shanghai", "CoreDiskSize": 100, "BackupStatus": "open", "IsHa": true, "ResourceGroupId": "rg-xxxxxxxxxxx" }
Error codes
The port number of a client that accesses a Error Center For more information, see error codes.