You can call this operation to query the list of databases with which the current instance can be associated.

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 QueryXpackRelateDB

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

ClusterId String Yes ap-bp1qtz9rcbbt3p6ng

The ID of the current Spark instance.

RelateDbType String Yes hbase

The type of the database to associate with.

Valid values for Spark: hdfs, hbase, mongodb, mysql, polardb_mysql, redis, and geomesa.

Valid values for BDS: hbase, spark, and hbaseue

HasSingleNode Boolean No false

Optional. The parameter takes effect only when the database type is HBase for BDS. true: A single-node HBase instance is included. false: a single-node HBase instance is not included. This parameter is designed for compatibility with single-node HBase instances.

Response parameters

Parameter Type Example Description
ClusterList Array

The list of databases that can be associated.

Cluster

The list of databases that can be associated.

ClusterId String hb-bp16o0pd52e3y582s

The ID of the instance.

ClusterName String hbase_test

The name of the instance.

DBType String hbase

The database type of the instance.

DBVersion String 2.0

The version of the instance.

IsRelated Boolean false

Indicates whether the instance is associated.

LockMode String ..

The lock mode.

Status String ACTIVATION

The status of the instance.

RequestId String 288E9010-36DD-499C-B4DA-61E4362DA4CC

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=QueryXpackRelateDB
&ClusterId=ap-bp1qtz9rcbbt3p6ng
&RelateDbType=hbase
&<Common request parameters>

Sample success responses

XML format

<RequestId>288E9010-36DD-499C-B4DA-61E4362DA4CC</RequestId>
<ClusterList>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>baitu-new-mem</ClusterName>
        <ClusterId>hb-bp16fd5z8srk9216p</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>COMP_ADDING</Status>
        <ClusterName>tianyin-ha2</ClusterName>
        <ClusterId>hb-bp16f1441y6p2kv2l</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>tianyin-ha1</ClusterName>
        <ClusterId>hb-bp1eu91b79o8h0n7i</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>wangjk-HBase</ClusterName>
        <ClusterId>hb-bp16o0pd52e3y582s</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>test-hbase-RESERVE</ClusterName>
        <ClusterId>hb-bp15w8hyzqi59p5yn</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
</ClusterList>

JSON format

{
	"RequestId":"288E9010-36DD-499C-B4DA-61E4362DA4CC",
	"ClusterList":{
		"Cluster":[
			{
				"Status":"ACTIVATION",
				"ClusterId":"hb-bp16fd5z8srk9216p",
				"ClusterName":"baitu-new-mem",
				"DBType":"hbase",
				"IsRelated":false
			},
			{
				"Status":"COMP_ADDING",
				"ClusterId":"hb-bp16f1441y6p2kv2l",
				"ClusterName":"tianyin-ha2",
				"DBType":"hbase",
				"IsRelated":false
			},
			{
				"Status":"ACTIVATION",
				"ClusterId":"hb-bp1eu91b79o8h0n7i",
				"ClusterName":"tianyin-ha1",
				"DBType":"hbase",
				"IsRelated":false
			},
			{
				"Status":"ACTIVATION",
				"ClusterId":"hb-bp16o0pd52e3y582s",
				"ClusterName":"wangjk-HBase",
				"DBType":"hbase",
				"IsRelated":false
			},
			{
				"Status":"ACTIVATION",
				"ClusterId":"hb-bp15w8hyzqi59p5yn",
				"ClusterName":"test-hbase-RESERVE",
				"DBType":"hbase",
				"IsRelated":false
			}
		]
	}
}

Error codes

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