Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Configuration/ Querying API that Support Parameter Templates
Updated on 2025-09-04 GMT+08:00

Querying API that Support Parameter Templates

Function

This API is used to query API that support parameter templates.

URI

GET https://{Endpoint}/v3/{project_id}/configurations/datastores

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

datastores

Array of Table 4 objects

Explanation:

Database API information

Values:

N/A

Table 4 DataStoreList

Parameter

Type

Description

datastore_name

String

Explanation:

Database API

Values:

N/A

version

String

Explanation:

Database API version

Values:

N/A

mode

String

Explanation:

Instance type

Values:

  • Cluster: GeminiDB Cassandra cluster instance with classic storage, GeminiDB Influx cluster instance with classic storage, or proxy cluster GeminiDB Redis instance with classic storage
  • CloudNativeCluster: GeminiDB Cassandra instance with cloud native storage
  • InfluxdbSingle: single-node GeminiDB Influx instance with classic storage
  • ReplicaSet: GeminiDB Mongo instances in a replica set

Example Request

  • URI example
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/datastores
  • Example request body

    None

Example Response

Status code: 200

Success

{ 
  "datastores" : [ { 
    "datastore_name" : "mongodb", 
    "mode": "ReplicaSet",
    "version" : "4.0" 
  }, { 
    "datastore_name" : "influxdb", 
    "mode": "InfluxdbCluster",
    "version" : "1.8" 
  }, { 
    "datastore_name" : "cassandra", 
    "mode": "ReplicaCircle",
    "version" : "3.11" 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.