更新时间:2025-08-21 GMT+08:00
分享

获取参数模板列表

功能介绍

获取参数模板列表,包括所有数据库的默认参数模板和用户创建的参数模板。

接口约束

该接口支持如下数据库实例:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx经典部署模式实例
  • GeminiDB Redis经典部署模式实例

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET https://{Endpoint}/v3.1/{project_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

索引位置,偏移量。

约束限制:

不涉及。

取值范围:

  • 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)
  • 取值必须为数字,且不能为负数。

默认取值:

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询个数上限值。

约束限制:

不涉及。

取值范围:

1~100。

默认取值:

不传该参数时,默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

总记录数。

取值范围:

不涉及。

quota

Integer

参数解释:

用户可创建的自定义参数模板最大数量。

取值范围:

不涉及。

configurations

Array of ListConfigurationsResult objects

参数解释:

参数模板列表。

取值范围:

不涉及。

表5 ListConfigurationsResult

参数

参数类型

描述

id

String

参数解释:

参数模板ID。

取值范围:

不涉及。

name

String

参数解释:

参数模板名称。

取值范围:

不涉及。

description

String

参数解释:

参数模板描述。

取值范围:

不涉及。

datastore_version_name

String

参数解释:

数据库版本名称。

取值范围:

不涉及。

datastore_name

String

参数解释:

数据库名称。

取值范围:

  • cassandra:表示支持GeminiDB Cassandra实例。
  • redis:表示支持GeminiDB Redis实例。
  • influxdb:表示支持GeminiDB Influx实例。
  • mongodb: 表示支持GeminiDB Mongo实例。

created

String

参数解释:

创建时间。

取值范围:

格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800

updated

String

参数解释:

更新时间。

取值范围:

格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800

mode

String

参数解释:

数据库实例类型。

取值范围:

  • 取值为“CloudNativeCluster”, 表示查询支持GeminiDB Cassandra云原生部署模式实例的参数模板。
  • 取值为“Cluster”, 表示查询GeminiDB Cassandra经典部署模式集群、GeminiDB Influx经典部署模式集群、GeminiDB Redis Proxy集群经典部署模式集群实例支持的参数模板。
  • 取值为“InfluxdbSingle”, 表示查询支持GeminiDB Influx经典部署模式单节点类型实例的参数模板。
  • 取值为“ReplicaSet”, 表示查询支持GeminiDB Mongo副本集类型实例的参数组。
  • 取值为“All”, 表示查询所有部署模式的参数模板。

user_defined

Boolean

参数解释:

是否是用户自定义参数模板。

取值范围:

  • false,表示为系统默认参数模板。
  • true,表示为用户自定义参数模板。

请求示例

URI样例
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&limit=10

响应示例

状态码: 200

Success

{
  "count" : 2,
  "quota": 100,
  "configurations" : [ {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr06",
    "name" : "configuration_test",
    "description" : "configuration_test",
    "datastore_version_name" : "3.11",
    "datastore_name" : "cassandra",
    "created" : "2019-05-15T11:53:34+0000",
    "updated" : "2019-05-15T11:53:34+0000",
    "mode": "Cluster",
    "user_defined" : true
  }, {
    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr06",
    "name" : "Default-Cassandra-3.11",
    "description" : "Default parameter group for cassandra 3.11",
    "datastore_version_name" : "3.11",
    "datastore_name" : "cassandra",
    "created" : "2019-05-27T03:38:51+0000",
    "updated" : "2019-05-27T03:38:51+0000",
    "mode": "Cluster",
    "user_defined" : false
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档