DescribeMultiZoneCluster - ApsaraDB for HBase - Alibaba Cloud Documentation Center

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMultiZoneCluster	The operation that you want to perform. Set the value to DescribeMultiZoneCluster.
ClusterId	String	Yes	ld-t4nn71xa0yn****	The ID of the multi-zone cluster that you want to query. You can call the DescribeInstances operation to obtain the list of ApsaraDB for HBase clusters. In the list, you can find the IDs of multi-zone clusters whose DbType is hbaseue and ModuleStackVersion is 2.0.

Response parameters

Parameter	Type	Example	Description
VpcId	String	vpc-t4nx81tmlixcq5****	The virtual private cloud (VPC) ID.
EncryptionType	String	CloudDisk	The encryption type. Valid values: NULL: Disk encryption is disabled. This is the default value. CloudDisk: Encryption is enabled on disks and the encryption key is specified by using the EncryptionKey parameter.
ModuleId	Integer	0	The module ID.
PayType	String	Prepaid	The billing method of the multi-zone cluster. Valid values: Prepaid: subscription Postpaid: pay-as-you-go
ArbiterVSwitchIds	String	vsw-t4nax9mp3wk0czn****	The ID of the vSwitch that is involved in arbitration.
MasterNodeCount	Integer	2	The number of master nodes.
RequestId	String	A02C0E6D-3A47-4FA0-BA7E-60793CE256DA	The request ID.
InstanceName	String	mz_test	The cluster name.
CoreInstanceType	String	hbase.sn1.large	The cluster type of the core node.
EncryptionKey	String	2a****	The ID of the encryption key. This value is empty if encryption is not enabled. Note Disk encryption cannot be disabled after it is enabled.
ClusterId	String	ld-t4nn71xa0yn****	The cluster ID.
LogNodeCount	Integer	4	The number of log nodes. Set this value to 4 or a greater value. The specified value must be a multiple of 4.
ExpireTime	String	2020-11-16T08:00:00	The time when the multi-zone cluster expires. The current time zone is used. This parameter is available only when the PayType parameter of the multi-zone cluster is set to Prepaid.
MultiZoneCombination	String	ap-southeast-1-abc-aliyun	The combination of zones for the multi-zone cluster specified in the request.
InstanceId	String	ld-t4nn71xa0yn****	The cluster ID.
IsDeletionProtection	Boolean	false	Indicates whether deletion protection is enabled on the multi-zone cluster. Valid values: true: Deletion protection is enabled. You cannot delete the cluster. false: Deletion protection is disabled. You can delete the cluster.
MasterDiskSize	Integer	50	The disk size of the master node.
AutoRenewal	Boolean	false	Indicates whether auto-renewal is enabled for the multi-zone cluster. This parameter is available only when the PayType parameter of the multi-zone cluster is set to Prepaid. true: Auto renewal is enabled. false: Auto renewal is disabled.
ClusterName	String	mz_test	The cluster name.
Duration	Integer	1	The auto-renewal period. This parameter is not returned for pay-as-you-go clusters. Monthly subscription: The auto-renewal period is one month. Annual subscription: The auto-renewal period is 1 year that is equal to 12 months.
ModuleStackVersion	String	2.0	The version of the module software stack.
MajorVersion	String	2.0	The version number of the engine. Only hbaseue 2.0 is supported.
CoreDiskCount	String	4	The number of core nodes.
Status	String	ACTIVATION	The cluster state. CREATING: The cluster is being created. ACTIVATION: The cluster is running. DELETING: The rule is being deleted. RESTARTING: The cluster is restarting.
LogInstanceType	String	hbase.sn1.large	The cluster type of the log node. You can call the DescribeInstanceType operation to obtain the value of this parameter.
LogDiskSize	Integer	100	The size of a single disk for the log node. Unit: GB.
CoreDiskType	String	cloud_efficiency	The disk type of the core node. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD local_hdd_pro: throughput-intensive local disk local_ssd_pro: I/O-intensive local disk
StandbyZoneId	String	ap-southeast-1b	The ID of the zone where the standby cluster is deployed.
NetworkType	String	VPC	The type of the network. Only the virtual private cloud (VPC) network type is supported.
PrimaryVSwitchIds	String	vsw-t4n3s1zd2gtidg****	The ID of the vSwitch for the primary cluster.
CreatedTimeUTC	String	2020-10-15T10:04:52Z	The time when the multi-zone cluster was created. The time is displayed in UTC.
ParentId	String	ld-fls1gf31y5s35****	The ID of the primary cluster of the module. This parameter is returned only when the specified cluster is a module.
ExpireTimeUTC	String	2020-11-16T00:00:00Z	The time when the multi-zone cluster expires. The time is displayed in UTC. This parameter is available only when the PayType parameter of the multi-zone cluster is set to Prepaid.
LogDiskType	String	cloud_efficiency	The disk type of the log node. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD local_hdd_pro: throughput-intensive local disk local_ssd_pro: I/O-intensive local disk
MasterInstanceType	String	hbase.sn1.large	The cluster type of the master node.
CreatedTime	String	2020-10-15T18:04:52	The time when the multi-zone cluster was created. The current time zone is used.
CoreDiskSize	Integer	100	The disk size of the core node. Unit: GB.
LogDiskCount	String	4	The number of disks for a single log node.
StandbyVSwitchIds	String	vsw-t4nvvk7xur3rdi****	The ID of the vSwitch for the standby cluster.
MaintainStartTime	String	02:00:00	The start time of the maintenance window. The time is displayed in the HH:MMZ format. Example: 20:00Z.
PrimaryZoneId	String	ap-southeast-1a	The ID of the zone where the primary cluster is deployed.
MaintainEndTime	String	06:00:00	The end time of the maintenance window. The time is displayed in the HH:MMZ format. Example: 20:00Z.
ArbiterZoneId	String	ap-southeast-1c	The ID of the zone where the arbiter is deployed.
MasterDiskType	String	cloud_efficiency	The disk type of the master node.
RegionId	String	ap-southeast-1	The region ID.
ResourceGroupId	String	rg-lk51f5fer315e****	The ID of the resource group to which the resource belongs.
Engine	String	hbaseue	The service type. Only hbaseue is supported.
CoreNodeCount	Integer	6	The number of core nodes. Set this value to 4 or a greater value. The specified value must be a multiple of 2.
ColdStorageSize	Integer	800	The size of cold storage. Unit: GB.
MultiZoneInstanceModels	Array of MultiZoneInstanceModel		The information about the child clusters of the specified multi-zone cluster in each zone.
MultiZoneInstanceModel
Status	String	ACTIVATION	The state of the child cluster.
IsLatestVersion	Boolean	true	Indicates whether the latest version is used.
Role	String	primary	The role of the child cluster.
InsName	String	ld-t4nn71xa0yn****-az-a	The name of the child cluster.
MinorVersion	String	2.1.24	The minor version of the cluster.
LatestMinorVersion	String	2.6.3	The latest version of the wide table engine.
HdfsMinorVersion	String	4.1.0	The current version of the storage engine.
LatestHdfsMinorVersion	String	4.1.1	The latest version of the storage engine.
IsHdfsLatestVersion	String	true	Indicates whether the storage engine uses the latest version.
Tags	Array of Tag		The tags of the cluster.
Tag
Key	String	test_key	The key of the tag.
Value	String	test_value	The value of the tag.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeMultiZoneCluster
&ClusterId=ld-t4nn71xa0yn****
&<Common request parameters>

Sample success responses

XML format

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

<StandbyZoneId>ap-southeast-1b</StandbyZoneId>
<ModuleStackVersion>2.0</ModuleStackVersion>
<CreatedTime>2020-10-15T18:04:52</CreatedTime>
<ResourceGroupId>rg-lk51f5fer315e****</ResourceGroupId>
<PrimaryVSwitchIds>vsw-t4n3s1zd2gtidg****</PrimaryVSwitchIds>
<MasterInstanceType>hbase.sn1.large</MasterInstanceType>
<LogDiskCount>4</LogDiskCount>
<IsDeletionProtection>false</IsDeletionProtection>
<LogDiskSize>100</LogDiskSize>
<ModuleId>0</ModuleId>
<ArbiterVSwitchIds>vsw-t4nax9mp3wk0czn****</ArbiterVSwitchIds>
<MaintainEndTime>06:00:00</MaintainEndTime>
<StandbyVSwitchIds>vsw-t4nvvk7xur3rdi****</StandbyVSwitchIds>
<NetworkType>VPC</NetworkType>
<CoreInstanceType>hbase.sn1.large</CoreInstanceType>
<ClusterName>mz_test</ClusterName>
<MasterDiskType>cloud_efficiency</MasterDiskType>
<MaintainStartTime>02:00:00</MaintainStartTime>
<Engine>hbaseue</Engine>
<Tags>
    <Tag>
        <Value>test_value</Value>
        <Key>test_key</Key>
    </Tag>
</Tags>
<ArbiterZoneId>ap-southeast-1c</ArbiterZoneId>
<Status>ACTIVATION</Status>
<ParentId>ld-fls1gf31y5s35****</ParentId>
<CoreDiskCount>4</CoreDiskCount>
<MajorVersion>2.0</MajorVersion>
<MultiZoneInstanceModels>
    <MultiZoneInstanceModel>
        <Role>primary</Role>
        <Status>ACTIVATION</Status>
        <IsLatestVersion>true</IsLatestVersion>
        <MinorVersion>2.1.24</MinorVersion>
        <InsName>ld-t4nn71xa0yn****-az-a</InsName>
    </MultiZoneInstanceModel>
</MultiZoneInstanceModels>
<PrimaryZoneId>ap-southeast-1a</PrimaryZoneId>
<MasterDiskSize>50</MasterDiskSize>
<ExpireTimeUTC>2020-11-16T00:00:00Z</ExpireTimeUTC>
<MultiZoneCombination>ap-southeast-1-abc-aliyun</MultiZoneCombination>
<RequestId>A02C0E6D-3A47-4FA0-BA7E-60793CE256DA</RequestId>
<CoreNodeCount>6</CoreNodeCount>
<InstanceId>ld-t4nn71xa0yn****</InstanceId>
<ClusterId>ld-t4nn71xa0yn****</ClusterId>
<CreatedTimeUTC>2020-10-15T10:04:52Z</CreatedTimeUTC>
<LogInstanceType>hbase.sn1.large</LogInstanceType>
<Duration>1</Duration>
<EncryptionKey>2a****</EncryptionKey>
<EncryptionType>CloudDisk</EncryptionType>
<PayType>Prepaid</PayType>
<MasterNodeCount>2</MasterNodeCount>
<InstanceName>mz_test</InstanceName>
<VpcId>vpc-t4nx81tmlixcq5****</VpcId>
<AutoRenewal>false</AutoRenewal>
<LogNodeCount>4</LogNodeCount>
<CoreDiskType>cloud_efficiency</CoreDiskType>
<LogDiskType>cloud_efficiency</LogDiskType>
<RegionId>ap-southeast-1</RegionId>
<ExpireTime>2020-11-16T08:00:00</ExpireTime>
<CoreDiskSize>100</CoreDiskSize>

JSON format

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

{
  "StandbyZoneId" : "ap-southeast-1b",
  "ModuleStackVersion" : "2.0",
  "CreatedTime" : "2020-10-15T18:04:52",
  "ResourceGroupId" : "rg-lk51f5fer315e****",
  "PrimaryVSwitchIds" : "vsw-t4n3s1zd2gtidg****",
  "MasterInstanceType" : "hbase.sn1.large",
  "LogDiskCount" : "4",
  "IsDeletionProtection" : "false",
  "LogDiskSize" : "100",
  "ModuleId" : "0",
  "ArbiterVSwitchIds" : "vsw-t4nax9mp3wk0czn****",
  "MaintainEndTime" : "06:00:00",
  "StandbyVSwitchIds" : "vsw-t4nvvk7xur3rdi****",
  "NetworkType" : "VPC",
  "CoreInstanceType" : "hbase.sn1.large",
  "ClusterName" : "mz_test",
  "MasterDiskType" : "cloud_efficiency",
  "MaintainStartTime" : "02:00:00",
  "Engine" : "hbaseue",
  "Tags" : {
    "Tag" : [ {
      "Value" : "test_value",
      "Key" : "test_key"
    } ]
  },
  "ArbiterZoneId" : "ap-southeast-1c",
  "Status" : "ACTIVATION",
  "ParentId" : "ld-fls1gf31y5s35****",
  "CoreDiskCount" : "4",
  "MajorVersion" : "2.0",
  "MultiZoneInstanceModels" : {
    "MultiZoneInstanceModel" : [ {
      "Role" : "primary",
      "Status" : "ACTIVATION",
      "IsLatestVersion" : "true",
      "MinorVersion" : "2.1.24",
      "InsName" : "ld-t4nn71xa0yn****-az-a"
    } ]
  },
  "PrimaryZoneId" : "ap-southeast-1a",
  "MasterDiskSize" : "50",
  "ExpireTimeUTC" : "2020-11-16T00:00:00Z",
  "MultiZoneCombination" : "ap-southeast-1-abc-aliyun",
  "RequestId" : "A02C0E6D-3A47-4FA0-BA7E-60793CE256DA",
  "CoreNodeCount" : "6",
  "InstanceId" : "ld-t4nn71xa0yn****",
  "ClusterId" : "ld-t4nn71xa0yn****",
  "CreatedTimeUTC" : "2020-10-15T10:04:52Z",
  "LogInstanceType" : "hbase.sn1.large",
  "Duration" : "1",
  "EncryptionKey" : "2a****",
  "EncryptionType" : "CloudDisk",
  "PayType" : "Prepaid",
  "MasterNodeCount" : "2",
  "InstanceName" : "mz_test",
  "VpcId" : "vpc-t4nx81tmlixcq5****",
  "AutoRenewal" : "false",
  "LogNodeCount" : "4",
  "CoreDiskType" : "cloud_efficiency",
  "LogDiskType" : "cloud_efficiency",
  "RegionId" : "ap-southeast-1",
  "ExpireTime" : "2020-11-16T08:00:00",
  "CoreDiskSize" : "100"
}

Error codes

For a list of error codes, see Service error codes.