Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Configuration/ Querying API that Support Parameter Templates
Updated on 2025-12-04 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

    -

    -

    -

    -

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

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

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

Range

N/A

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

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 which 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 which classic storage
  • CloudNativeCluster: GeminiDB Redis cluster instance with cloud native storage
  • RedisCluster: Redis Cluster GeminiDB Redis instance which classic storage. For more information about the Redis Cluster GeminiDB Redis instance, see "Creating an Instance".
  • Replication: primary/standby GeminiDB Redis instance with classic storage

Example Requests

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

    None

Example Responses

Status code: 200

Successful response

{ 
  "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.