根据id查询集群基本信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstance |
系统规定参数。取值:DescribeInstance。 |
ClusterId | String | 是 | hb-bp16f1441y6p2kv** |
要查询的集群id |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupStatus | String | open |
备份恢复状态: open-展示备份恢复 close-不展示备份恢复 |
ClusterId | String | hb-bp16f1441y6p2kv** |
集群ID,系统生成的唯一标识码。等于InstanceId,建议统一使用ClusterId。 |
ClusterName | String | test |
集群名称,等于InstanceName,建议统一使用ClusterName。 |
ClusterType | String | cluster |
集群类型,cluster/single |
ColdStorageStatus | String | open |
冷热分离状态: open-有冷热分离页面 close-无冷热分离页面 |
CoreDiskCount | String | 2 |
Core磁盘数量 |
CoreDiskSize | Integer | 100 |
core节点磁盘大小,默认单位G |
CoreDiskType | String | cloud_efficiency |
core节点磁盘类型 cloud_efficiency 高效云盘 cloud_ssd ssd云盘 |
CoreInstanceType | String | hbase.sn1.large |
core节点实例类型 |
CoreNodeCount | Integer | 2 |
core节点个数 |
CreatedTime | String | 2019-09-12T14:40:46 |
集群创建时间 |
CreatedTimeUTC | String | 2019-09-12T14:40:46Z |
创建时间,UTC格式 |
Engine | String | hbase |
产品引擎 hbase spark geomesa ... |
ExpireTime | String | 2019-10-12T14:40:46 |
失效时间 |
InstanceName | String | openapi-test |
集群name,用户可自行设置,等于ClusterName,建议统一使用ClusterName。 |
ExpireTimeUTC | String | 2019-10-12T14:40:46Z |
失效时间, UTC格式 |
InstanceId | String | hb-bp16f1441y6p2kv** |
集群ID,系统生成的唯一标识码,兼容老客户,等于ClusterId,建议统一使用ClusterId。 |
IsHa | Boolean | true |
是否高可用?true/false |
IsLatestVersion | Boolean | true |
true/false 是否最新版本 |
IsMultiModel | Boolean | true |
true/false, 是否多模 |
MaintainEndTime | String | 4:00 |
实例运维结束时间 |
MaintainStartTime | String | 2:00 |
实例运维开始时间 |
MajorVersion | String | 2.0 |
主版本号 |
MasterDiskSize | Integer | 100 |
主节点磁盘大小,默认单位G |
MasterDiskType | String | cloud_efficiency |
主节点磁盘类型 cloud_efficiency 高效云盘 cloud_ssd ssd云盘 |
MasterInstanceType | String | hbase.sn1.large |
主节点实例类型 |
MasterNodeCount | Integer | 2 |
主节点个数 为单节点时既是master也是core,此时返回0 为ha高可用时是2 |
MinorVersion | String | 2.0.8 |
小版本号 |
NetworkType | String | VPC |
网络类型, VPC VPC网络类型 CLASSIC 经典网络类型 如果为VPC, 就有vSwitchId, vpcId |
PayType | String | Postpaid |
付费类型:
|
RegionId | String | cn-shanghai |
实例所属地域ID |
RequestId | String | EBECBF12-2E34-41BE-8DE9-FC3700D4D6** |
request Id 自动生成的唯一请求标识码 |
Status | String | ACTIVATION |
集群状态 CREATING创建中 ACTIVATION运行中 DELETING删除中 RESTARTING重启中... |
Tags | Array of Tag |
资源标签 |
|
Tag | |||
Key | String | test_key |
标签Key值 |
Value | String | test_value |
标签Value值 |
VpcId | String | vpc-bp120k6ixs4eoghz***** |
专有网络vpcId,NetworkType为2时会有,vpc-xxxx |
VswitchId | String | vsw-bp191ipotq****dbqf |
虚拟交换机id,NetworkType为2时会有,vsw-xxxx |
ZoneId | String | cn-hangzhou-f |
实例所属可用区ID |
IsDeletionProtection | Boolean | true |
是否开启删除保护 |
ModuleId | Integer | 1 |
模块ID |
ModuleStackVersion | String | 5.0 |
模块堆栈版本 |
ParentId | String | ld-uf699153o****1m2l |
父实例ID。 |
AutoRenewal | Boolean | true |
是否自动续费。可取值:true/false 说明 后付费实例无此返回值
|
ColdStorageSize | Integer | 800 |
冷存储空间大小。 |
Duration | Integer | 12 |
自动续费周期。
说明 后付费实例无此返回值
|
ResourceGroupId | String | rg-xxxxxxxxxxx |
资源所在的资源组Id。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeInstance
&ClusterId=hb-bp16f1441y6p2kv**
&<公共请求参数>
正常返回示例
XML
格式
<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
格式
{
"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"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交