Queries the connection information about an instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeClusterConnection |
The operation that you want to perform. Set the value to DescribeClusterConnection. |
ClusterId | String | Yes | hb-bp16f1441y6p2**** |
The ID of the instance. |
RegionId | String | Yes | cn-shenzhen |
The ID of the region. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DbType | String | hbase |
The type of the database. |
IsMultimod | String | true |
Indicates whether the instance is managed in multiple modes. |
NetType | String | VPC |
The type of the network. |
RequestId | String | EBECBF12-2E34-41BE-8DE9-FC3700D4D6 |
The ID of the request. |
ServiceConnAddrs | Array of ServiceConnAddr |
The list of sub-service addresses. |
|
ConnAddrInfo | Struct |
The address object. |
|
ConnAddr | String | hb-****-proxy-phoenix.hbase.rds.aliyuncs.com |
The Phoenix address. |
ConnAddrPort | String | 8765 |
The number of the port over which Phoenix connects to the instance. |
NetType | String | 2 |
The type of the network. Valid values:
|
ConnType | String | PhoenixConnAddr |
The type of the service. |
SlbConnAddrs | Array of SlbConnAddr |
The list of Server Load Balancer (SLB) instance addresses. |
|
ConnAddrInfo | Struct |
The address object. |
|
ConnAddr | String | hb-****-proxy-phoenix.hbase.rds.aliyuncs.com |
The address. |
ConnAddrPort | String | 8765 |
The number of the port over which Phoenix connects to the instance. |
NetType | String | 2 |
The type of the network. Valid values:
|
SlbType | String | phoenix |
The type of the SLB service. Valid values include thrift and Phoenix. |
ThriftConn | Struct |
The object of the Thrift address. |
|
ConnAddr | String | hb-****-master3-001.hbase.rds.aliyuncs.com |
The Thrift address. |
ConnAddrPort | String | 9099 |
The number of the port over which Phoenix connects to the instance. |
NetType | String | 2 |
The type of the network.
|
UiProxyConnAddrInfo | Struct |
The list of web UI addresses. |
|
ConnAddr | String | hb-****-nginx-master1-001.hbase.rds.aliyuncs.com |
The web UI address. |
ConnAddrPort | String | 443 |
The port number of the web UI. |
NetType | String | PUBLIC |
The type of the network. Valid values:
|
VSwitchId | String | vsw-bp191ipotqj1ss**** |
The ID of the vSwitch. |
VpcId | String | vpc-bp120k6ixs4eoghz**** |
The ID of the virtual private cloud (VPC). |
ZkConnAddrs | Array of ZkConnAddr |
The list of ZooKeeper addresses. |
|
ConnAddr | String | hb-****-master1-001.hbase.rds.aliyuncs.com |
The ZooKeeper address. |
ConnAddrPort | String | 2181 |
The number of the port over which ZooKeeper connects to the instance. |
NetType | String | 2 |
The type of the network.
|
Examples
Sample requests
http(s)://hbase.aliyuncs.com/?Action=DescribeClusterConnection
&ClusterId=hb-bp16f1441y6p2****
&RegionId=cn-shenzhen
&<Common request parameters>
Sample success responses
XML
format
<IsMultimod>true</IsMultimod>
<VpcId>vpc-bp120k6ixs4eoghz****</VpcId>
<RequestId>EBECBF12-2E34-41BE-8DE9-FC3700D4****</RequestId>
<UiProxyConnAddrInfo>
<ConnAddrPort>443</ConnAddrPort>
<ConnAddr>hb-****-nginx-master1-001.hbase.rds.aliyuncs.com</ConnAddr>
<NetType>PUBLIC</NetType>
</UiProxyConnAddrInfo>
<VSwitchId>vsw-bp191ipotqj1ss****</VSwitchId>
<ServiceConnAddrs>
<ConnType>PhoenixConnAddr</ConnType>
</ServiceConnAddrs>
<ServiceConnAddrs>
<ConnAddrInfo>
<ConnAddrPort>8765</ConnAddrPort>
<ConnAddr>hb-****-proxy-phoenix.hbase.rds.aliyuncs.com</ConnAddr>
<NetType>2</NetType>
</ConnAddrInfo>
</ServiceConnAddrs>
<NetType>VPC</NetType>
<DbType>hbase</DbType>
<ThriftConn>
<ConnAddrPort>9099</ConnAddrPort>
<ConnAddr>hb-****-master3-001.hbase.rds.aliyuncs.com</ConnAddr>
<NetType>2</NetType>
</ThriftConn>
<ZkConnAddrs>
<ConnAddr>hb-****-master1-001.hbase.rds.aliyuncs.com</ConnAddr>
<ConnAddrPort>2181</ConnAddrPort>
<NetType>2</NetType>
</ZkConnAddrs>
<SlbConnAddrs>
<SlbType>phoenix</SlbType>
</SlbConnAddrs>
<SlbConnAddrs>
<ConnAddrInfo>
<ConnAddrPort>8765</ConnAddrPort>
<ConnAddr>hb-****-proxy-phoenix.hbase.rds.aliyuncs.com</ConnAddr>
<NetType>2</NetType>
</ConnAddrInfo>
</SlbConnAddrs>
JSON
format
{"IsMultimod":"true","VpcId":"vpc-bp120k6ixs4eoghz****","RequestId":"EBECBF12-2E34-41BE-8DE9-FC3700D4****","UiProxyConnAddrInfo":{"ConnAddrPort":"443","ConnAddr":"hb-****-nginx-master1-001.hbase.rds.aliyuncs.com","NetType":"PUBLIC"},"VSwitchId":"vsw-bp191ipotqj1ss****","ServiceConnAddrs":[{"ConnType":"PhoenixConnAddr"},{"ConnAddrInfo":{"ConnAddrPort":"8765","ConnAddr":"hb-****-proxy-phoenix.hbase.rds.aliyuncs.com","NetType":"2"}}],"NetType":"VPC","DbType":"hbase","ThriftConn":{"ConnAddrPort":"9099","ConnAddr":"hb-****-master3-001.hbase.rds.aliyuncs.com","NetType":"2"},"ZkConnAddrs":[{"ConnAddr":"hb-****-master1-001.hbase.rds.aliyuncs.com","ConnAddrPort":"2181","NetType":"2"}],"SlbConnAddrs":[{"SlbType":"phoenix"},{"ConnAddrInfo":{"ConnAddrPort":"8765","ConnAddr":"hb-****-proxy-phoenix.hbase.rds.aliyuncs.com","NetType":"2"}}]}
Error codes
For a list of error codes, visit the API Error Center.