Updated on 2026-09-22 GMT+08:00

Querying API that Support Parameter Templates

Function

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

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

gaussdbfornosql:datastore:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:datastore:list	List	-	-	-	-

URI

GET /v3/{project_id}/configurations/datastores

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range 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	Definition Database API information

**Table 4** DataStoreList
Parameter	Type	Description
datastore_name	String	Definition Database API Range cassandra: GeminiDB Cassandra instance mongodb: GeminiDB Mongo instance influxdb: GeminiDB Influx instance redis: GeminiDB Redis instance dynamodb: GeminiDB DynamoDB-Compatible instance hbase: GeminiDB HBase instance
version	String	Definition Database API version Range 3.11: GeminiDB Cassandra instance 3.11 4.0: GeminiDB Mongo instance 4.0 1.8: GeminiDB Influx instance 1.8 5.0: GeminiDB Redis instance 5.0 "": GeminiDB DynamoDB-Compatible instance "": GeminiDB HBase instance
mode	String	Definition Instance type Range Cluster: GeminiDB Cassandra cluster instance with classic storage CloudNativeCluster: GeminiDB Cassandra cluster instance with cloud native storage ReplicaSet: GeminiDB Mongo instance 4.0 in a replica set Cluster: GeminiDB Influx cluster instance with classic storage CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage EnhancedCluster: GeminiDB Influx cluster (performance-enhanced) instance with classic storage InfluxdbSingle: single-node GeminiDB Influx instance Cluster: proxy cluster GeminiDB Redis instance with classic storage CloudNativeCluster: GeminiDB Redis cluster instance with cloud native storage RedisCluster: Redis Cluster GeminiDB Redis instance with classic storage Replication: primary/standby GeminiDB Redis instance with classic storage

Example Requests

URI example

GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/datastores

Example Responses

Status code: 200

Success

{
 "datastores": [
  {
   "datastore_name": "mongodb",
   "mode": "ReplicaSet",
   "version": "4.0"
  },
  {
   "datastore_name": "influxdb",
   "mode": "Cluster",
   "version": "1.8"
  },
  {
   "datastore_name": "influxdb",
   "mode": "InfluxdbSingle",
   "version": "1.8"
  },
  {
   "datastore_name": "influxdb",
   "mode": "Cluster",
   "version": "1.8"
  },
  {
   "datastore_name": "influxdb",
   "mode": "InfluxdbSingle",
   "version": "1.8"
  },
  {
   "datastore_name": "redis",
   "mode": "Cluster",
   "version": "5.0"
  },
  {
   "datastore_name": "redis",
   "mode": "CloudNativeCluster",
   "version": "5.0"
  },
  {
   "datastore_name": "influxdb",
   "mode": "EnhancedCluster",
   "version": "1.8"
  },
  {
   "datastore_name": "influxdb",
   "mode": "CloudNativeCluster",
   "version": "1.8"
  },
  {
   "datastore_name": "cassandra",
   "mode": "CloudNativeCluster",
   "version": "3.11"
  },
  {
   "datastore_name": "cassandra",
   "mode": "Cluster",
   "version": "3.11"
  }
 ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration