Queries the 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-bp1qtz9rcbbt3****

The ID of the current Apache Spark instance.

RelateDbType String Yes hbase

The type of the database to associate with.

  • Valid values for an Apache Spark instance: hdfs, hbase, mongodb, mysql, polardb_mysql, redis, and geomesa.
  • Valid values for a Lindorm Tunnel Service (LTS) instance: hbase, spark, and hbaseue.
HasSingleNode Boolean No false

Specifies whether single-node ApsaraDB for HBase instances are included. The parameter only takes effect when you query the databases that can be associated with a Big DataHub Service (BDS) instance and you set the RelateDbType parameter to hbase.

  • true: Single-node ApsaraDB for HBase instances are included.
  • false: Single-node ApsaraDB for HBase instances are not included. This parameter is optional. It is designed for compatibility with the previous logic: If the corresponding parameter is left empty, single-node ApsaraDB for HBase instances are included.

Response parameters

Parameter Type Example Description
ClusterList Array of Cluster

The list of databases that can be associated with.

Cluster
ClusterId String hb-bp16o0pd52e3y****

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 with databases.

LockMode String ..

The lock mode.

Status String ACTIVATION

The status of the instance.

RequestId String 288E9010-36DD-499C-B4DA-61E4362D****

The ID of the request.

Examples

Sample requests

http(s)://hbase.aliyuncs.com/?Action=QueryXpackRelateDB
&ClusterId=ap-bp1qtz9rcbbt3****
&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-bp16fd5z8srk9****</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>COMP_ADDING</Status>
        <ClusterName>tianyin-ha2</ClusterName>
        <ClusterId>hb-bp16f1441y6p2****</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>tianyin-ha1</ClusterName>
        <ClusterId>hb-bp1eu91b79o8h****</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>wangjk-HBase</ClusterName>
        <ClusterId>hb-bp16o0pd52e3y****</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
    <Cluster>
        <Status>ACTIVATION</Status>
        <ClusterName>test-hbase-RESERVE</ClusterName>
        <ClusterId>hb-bp15w8hyzqi59****</ClusterId>
        <IsRelated>false</IsRelated>
        <DBType>hbase</DBType>
    </Cluster>
</ClusterList>

JSON format

{
  "RequestId": "288E9010-36DD-499C-B4DA-61E4362DA4CC",
  "ClusterList": {
    "Cluster": [
      {
        "Status": "ACTIVATION",
        "ClusterName": "baitu-new-mem",
        "ClusterId": "hb-bp16fd5z8srk9****",
        "IsRelated": false,
        "DBType": "hbase"
      },
      {
        "Status": "COMP_ADDING",
        "ClusterName": "tianyin-ha2",
        "ClusterId": "hb-bp16f1441y6p2****",
        "IsRelated": false,
        "DBType": "hbase"
      },
      {
        "Status": "ACTIVATION",
        "ClusterName": "tianyin-ha1",
        "ClusterId": "hb-bp1eu91b79o8h****",
        "IsRelated": false,
        "DBType": "hbase"
      },
      {
        "Status": "ACTIVATION",
        "ClusterName": "wangjk-HBase",
        "ClusterId": "hb-bp16o0pd52e3y****",
        "IsRelated": false,
        "DBType": "hbase"
      },
      {
        "Status": "ACTIVATION",
        "ClusterName": "test-hbase-RESERVE",
        "ClusterId": "hb-bp15w8hyzqi59****",
        "IsRelated": false,
        "DBType": "hbase"
      }
    ]
  }
}

Error codes

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