文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 参数配置/ 查询支持参数模板的接口信息 - QueryingAPIthatSupportParameterTemplates
更新时间：2025-11-27 GMT+08:00
查看PDF
分享

查询支持参数模板的接口信息 - QueryingAPIthatSupportParameterTemplates

功能介绍

查询支持参数模板的接口信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:datastore:list

    List

    -

    -

    -

    -

URI

GET /v3/{project_id}/configurations/datastores

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

datastores

Array of 表4 objects

参数解释：

数据库接口信息。

取值范围：

不涉及。
表4 DataStoreList

参数

参数类型

描述

datastore_name

String

参数解释：

数据库接口。

取值范围：

  • GeminiDB Cassandra实例取值为“cassandra”。
  • GeminiDB Mongo实例取值为"mongodb"。
  • GeminiDB Influx实例取值为"influxdb"。
  • GeminiDB Redis实例取值为"redis"。
  • GeminiDB兼容DynamoDB实例取值为"dynamodb"。
  • GeminiDB HBase实例取值为"hbase"。

version

String

参数解释：

数据库接口版本。

取值范围：

  • GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。
  • GeminiDB Mongo实例支持4.0版本，取值为"4.0"。
  • GeminiDB Influx实例支持1.8版本，取值"1.8"。
  • GeminiDB Redis实例支持5.0版本，取值"5.0"。

mode

String

参数解释：

实例类型。

取值范围：

  • GeminiDB Cassandra支持经典部署模式集群类型，取值为“Cluster”。
  • GeminiDB Cassandra支持云原生部署模式集群类型，取值“CloudNativeCluster”。
  • GeminiDB Mongo 4.0版本支持副本集类型，取值为“ReplicaSet”。
  • GeminiDB Influx支持经典部署模式集群类型，取值为“Cluster”。
  • GeminiDB Influx支持云原生部署模式集群增强版类型，取值为“CloudNativeCluster”。
  • GeminiDB Influx支持经典部署模式集群增强版类型，取值为“EnhancedCluster”。
  • GeminiDB Influx支持单节点类型，取值为“InfluxdbSingle”。
  • GeminiDB Redis支持经典部署模式Proxy集群类型，取值为“Cluster”。
  • GeminiDB Redis支持云原生部署模式集群类型，取值为“CloudNativeCluster”。
  • GeminiDB Redis支持经典部署模式Cluster集群类型，取值为“RedisCluster”。Cluster集群实例类型介绍请参见创建实例。
  • GeminiDB Redis支持经典部署模式主备类型，取值为“Replication”。

请求示例

  • URI样例 
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/datastores
  • 请求体样例

    无。

响应示例

状态码： 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" 
  } ] 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数配置