文档

DescribeMultiZoneCluster

更新时间:

调用DescribeMultiZoneCluster可以获取多可用区实例的详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeMultiZoneCluster

系统规定参数。取值:DescribeMultiZoneCluster

ClusterId String ld-t4nn71xa0yn****

多可用区实例的Id,可通过DescribeInstances获取列表,列表中DbType为hbaseue且ModuleStackVersion为2.0的多可用区实例。

返回数据

名称

类型

示例值

描述

VpcId String vpc-t4nx81tmlixcq5****

专有网络ID。

EncryptionType String CloudDisk

加密类型,可选项为:

  • NULL:不启用加密(默认值)。
  • CloudDisk:云盘加密并通过EncryptionKey参数指定密钥。
ModuleId Integer 0

组件ID。

PayType String Prepaid

付费类型。

  • Prepaid:预付费。
  • Postpaid:后付费。
ArbiterVSwitchIds String vsw-t4nax9mp3wk0czn****

仲裁虚拟交换机ID。

MasterNodeCount Integer 2

master节点数量。

RequestId String A02C0E6D-3A47-4FA0-BA7E-60793CE256DA

请求ID。

InstanceName String mz_test

集群名称。

CoreInstanceType String hbase.sn1.large

core节点规格。

EncryptionKey String 2a****

加密的密钥ID,如果未启用加密则为空。

说明 当前云盘加密开启后无法关闭。
ClusterId String ld-t4nn71xa0yn****

集群ID。

LogNodeCount Integer 4

log节点数量,4节点起,且为4的倍数。

ExpireTime String 2020-11-16T08:00:00

过期时间,预付费(PayType为Prepaid)时有此字段(当前时区)。

MultiZoneCombination String ap-southeast-1-abc-aliyun

当前多可用区实例的可用区组合。

InstanceId String ld-t4nn71xa0yn****

集群ID。

IsDeletionProtection Boolean false

是否启动删除保护:

  • True:启动,不能删除,删除时会提示禁止删除。
  • False:不启动,可以删除。
MasterDiskSize Integer 50

master节点磁盘大小。

AutoRenewal Boolean false

对于PayType为预付费(Prepaid)的多可用区实例,有此是否自动续费字段。

  • True:自动续费。
  • False:不自动续费。
ClusterName String mz_test

集群名称。

Duration Integer 1

自动续费周期,后付费实例无此返回值。

  • 按月购买:则自动续费周期为1 个月。
  • 按年购买:则自动续费周期为1 年(12个月)。
ModuleStackVersion String 2.0

组件软件栈版本。

MajorVersion String 2.0

根据引擎类型的版本号,目前仅支持hbaseue的2.0版本。

CoreDiskCount String 4

core节点数量。

Status String ACTIVATION

集群状态。

  • CREATING:创建中。
  • ACTIVATION:运行中。
  • DELETING:删除中。
  • RESTARTING:重启中。
LogInstanceType String hbase.sn1.large

log节点规格, 可以从DescribeInstanceType接口查询到准确的信息。

LogDiskSize Integer 100

log节点单个磁盘大小,单位:GB。

CoreDiskType String cloud_efficiency

core磁盘类型:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD盘。
  • local_hdd_pro:吞吐密集型本地盘。
  • local_ssd_pro:I/O密集型本地盘。
StandbyZoneId String ap-southeast-1b

备可用区实例的可用区ID。

NetworkType String VPC

网络类型,目前仅支持VPC。

PrimaryVSwitchIds String vsw-t4n3s1zd2gtidg****

主可用区实例的虚拟交换机ID。

CreatedTimeUTC String 2020-10-15T10:04:52Z

创建时间,UTC时间。

ParentId String ld-fls1gf31y5s35****

如果为组件实例,会有此字段显示其主实例ID。

ExpireTimeUTC String 2020-11-16T00:00:00Z

过期时间,预付费(PayType为Prepaid)时有此字段(UTC时间)。

LogDiskType String cloud_efficiency

log节点磁盘类型。

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD盘。
  • local_hdd_pro:吞吐密集型本地盘。
  • local_ssd_pro:I/O密集型本地盘。
MasterInstanceType String hbase.sn1.large

master节点规格。

CreatedTime String 2020-10-15T18:04:52

创建时间,当前时区的时间。

CoreDiskSize Integer 100

core节点磁盘大小,单位GB。

LogDiskCount String 4

log单节点的磁盘数量。

StandbyVSwitchIds String vsw-t4nvvk7xur3rdi****

备可用区实例的虚拟交换机ID。

MaintainStartTime String 02:00:00

可运维时间开始时间。HH:MMZ样式,如20:00Z。

PrimaryZoneId String ap-southeast-1a

主可用区实例的可用区ID。

MaintainEndTime String 06:00:00

可运维时间结束时间。HH:MMZ样式,如20:00Z。

ArbiterZoneId String ap-southeast-1c

仲裁可用区ID。

MasterDiskType String cloud_efficiency

master节点磁盘类型。

RegionId String ap-southeast-1

地域ID。

ResourceGroupId String rg-lk51f5fer315e****

资源所在的资源组ID。

Engine String hbaseue

服务类型:目前仅支持hbaseue。

CoreNodeCount Integer 6

core节点个数,4节点起,且增量为2的倍数。

ColdStorageSize Integer 800

冷存储大小。单位:GB。

MultiZoneInstanceModels Array of MultiZoneInstanceModel

该多可用区实例下各个可用区实例信息。

MultiZoneInstanceModel
Status String ACTIVATION

该子实例的状态。

IsLatestVersion Boolean true

是否最新版本。

Role String primary

该子实例的角色。

InsName String ld-t4nn71xa0yn****-az-a

子实例名称。

MinorVersion String 2.1.24

本实例小版本号。

LatestMinorVersion String 2.6.3

宽表引擎当前的最新版本。

HdfsMinorVersion String 4.1.0

存储引擎当前版本号。

LatestHdfsMinorVersion String 4.1.1

存储引擎当前最新版本号。

IsHdfsLatestVersion String true

存储引擎是否是最新版本。

Tags Array of Tag

集群标签。

Tag
Key String test_key

标签的Key。

Value String test_value

标签的Value。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMultiZoneCluster
&ClusterId=ld-t4nn71xa0yn****
&<公共请求参数>

正常返回示例

XML格式

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格式

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

错误码

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

  • 本页导读 (1)