You can call this operation to query the connection information of a cluster database based on the cluster ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeEndpoints

The operation that you want to perform. Set the value to DescribeEndpoints.

ClusterId String Yes hb-bp16f1441y6p2kv**

The ID of the cluster that you want to query.

Response parameters

Parameter Type Example Description
ConnAddrs Array

The list of connections.

ConnAddrInfo

The list of detailed connection information.

ConnAddr String hb-bp16o0pd52e3y582s-master2-001.hbase.rds.aliyuncs.com

The connection address.

ConnAddrPort String 2181

The connection port.

ConnType String zkConn

The connection type. Valid values:

uiProxyConn: The connection address of the user interface (UI).

zkConn: The connection address of ZooKeeper.

thriftConn: The connection address of Thrift.

slbConn_thrift: The connection address of Thrift for Server Load Balancer (SLB).

serviceConn_LivyConnAddr: The connection address of Livy.

...

NetType String 2

The network type of the connection. Valid values:

If the NetType parameter is set to 0, the network type of the connection is Internet.

If the NetType parameter is set to 1, the network type of the connection is private network.

If the NetType parameter is set to 2, the network type of the connection is VPC.

Engine String hbase

The product engine.

hbase

spark

geomesa

...

NetType String VPC

The network type. If the network is VPC, the value of vpcId is returned. Valid values:

VPC

CLASSIC

If the network type is VPC, the values of vSwitchId and vpcId are returned.

RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4D6**

The ID of the request. It is the unique ID that is dynamically generated for the request.

VSwitchId String vsw-bp191ipotq****dbqf

The ID of the VSwitch. When the value of NetType is 2, this value is returned. Example: vsw-xxxx.

VpcId String vpc-bp120k6ixs4eoghz*****

The ID of the VPC. When the value of NetType is 2, this value is returned. Example: vpc-xxxx.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeEndpoints
&ClusterId=hb-bp16f1441y6p2kv**
&<Common request parameters>

Sample success responses

XML format

<ConnAddrs>
    <ConnAddrInfo>
        <ConnType>uiProxyConn</ConnType>
        <ConnAddrPort>443</ConnAddrPort>
        <NetType>PUBLIC</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-nginx-master1-001.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
    <ConnAddrInfo>
        <ConnType>zkConn</ConnType>
        <ConnAddrPort>2181</ConnAddrPort>
        <NetType>2</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-master2-001.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
    <ConnAddrInfo>
        <ConnType>zkConn</ConnType>
        <ConnAddrPort>2181</ConnAddrPort>
        <NetType>2</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-master3-001.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
    <ConnAddrInfo>
        <ConnType>thriftConn</ConnType>
        <ConnAddrPort>9099</ConnAddrPort>
        <NetType>2</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-master3-001.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
    <ConnAddrInfo>
        <ConnType>zkConn</ConnType>
        <ConnAddrPort>2181</ConnAddrPort>
        <NetType>2</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-master1-001.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
    <ConnAddrInfo>
        <ConnType>thriftConn</ConnType>
        <ConnAddrPort>9099</ConnAddrPort>
        <NetType>2</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-core-001.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
    <ConnAddrInfo>
        <ConnType>slbConn_thrift</ConnType>
        <ConnAddrPort>9099</ConnAddrPort>
        <NetType>2</NetType>
        <ConnAddr>hb-bp16o0pd52e3y582s-proxy-thrift.hbase.rds.aliyuncs.com</ConnAddr>
    </ConnAddrInfo>
</ConnAddrs>
<RequestId>036C0840-DE57-4838-8AED-0C062541102F</RequestId>
<NetType>VPC</NetType>
<VSwitchId>vsw-bp191ipotqj1ssyl7dbqf</VSwitchId>
<Engine>hbase</Engine>
<VpcId>vpc-bp120k6ixs4eoghzwvu6x</VpcId>

JSON format

{
	"ConnAddrs":{
		"ConnAddrInfo":[
			{
				"ConnType":"uiProxyConn",
				"ConnAddrPort":443,
				"NetType":"PUBLIC",
				"ConnAddr":"hb-bp16o0pd52e3y582s-nginx-master1-001.hbase.rds.aliyuncs.com"
			},
			{
				"ConnType":"zkConn",
				"ConnAddrPort":2181,
				"NetType":"2",
				"ConnAddr":"hb-bp16o0pd52e3y582s-master2-001.hbase.rds.aliyuncs.com"
			},
			{
				"ConnType":"zkConn",
				"ConnAddrPort":2181,
				"NetType":"2",
				"ConnAddr":"hb-bp16o0pd52e3y582s-master3-001.hbase.rds.aliyuncs.com"
			},
			{
				"ConnType":"thriftConn",
				"ConnAddrPort":9099,
				"NetType":"2",
				"ConnAddr":"hb-bp16o0pd52e3y582s-master3-001.hbase.rds.aliyuncs.com"
			},
			{
				"ConnType":"zkConn",
				"ConnAddrPort":2181,
				"NetType":"2",
				"ConnAddr":"hb-bp16o0pd52e3y582s-master1-001.hbase.rds.aliyuncs.com"
			},
			{
				"ConnType":"thriftConn",
				"ConnAddrPort":9099,
				"NetType":"2",
				"ConnAddr":"hb-bp16o0pd52e3y582s-core-001.hbase.rds.aliyuncs.com"
			},
			{
				"ConnType":"slbConn_thrift",
				"ConnAddrPort":9099,
				"NetType":"2",
				"ConnAddr":"hb-bp16o0pd52e3y582s-proxy-thrift.hbase.rds.aliyuncs.com"
			}
		]
	},
	"RequestId":"036C0840-DE57-4838-8AED-0C062541102F",
	"NetType":"VPC",
	"VSwitchId":"vsw-bp191ipotqj1ssyl7dbqf",
	"VpcId":"vpc-bp120k6ixs4eoghzwvu6x",
	"Engine":"hbase"
}

Error codes

For a list of error codes, visit the API Error Center.