获取参数模板列表 - ObtainingParameterTemplates
功能介绍
获取参数模板列表,包括所有数据库的默认参数模板和用户创建的参数模板。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
gaussdbfornosql:configuration:list
List
-
-
nosql:param:list
-
URI
GET /v3.1/{project_id}/configurations
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
user_defined | 否 | Boolean | 参数解释: 是否用户自定义。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: false。 |
name | 否 | String | 参数解释: 参数模板名字。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
offset | 否 | Integer | 参数解释: 索引位置,偏移量。 约束限制: 不涉及。 取值范围:
默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
limit | 否 | Integer | 参数解释: 查询个数上限值。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 不传该参数时,默认查询前100条信息。 |
datastore_name | 否 | String | 参数解释: 数据库名称。 约束限制: 不限制。 取值范围:
默认取值: 不传该参数,则表示查询所有数据库类型。 |
mode | 否 | String | 参数解释: 数据库实例类型。 约束限制: 不限制。 取值范围:
默认取值: 不传该参数,则表示查询经典部署模式实例支持的参数组。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 总记录数。 取值范围: 不涉及。 |
quota | Integer | 参数解释: 用户可创建的自定义参数模板最大数量。 取值范围: 不涉及。 |
configurations | Array of ListConfigurationsResult objects | 参数解释: 参数模板列表。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 参数模板ID。 取值范围: 不涉及。 |
name | String | 参数解释: 参数模板名称。 取值范围: 不涉及。 |
description | String | 参数解释: 参数模板描述。 取值范围: 不涉及。 |
datastore_version_name | String | 参数解释: 数据库版本名称。 取值范围: 不涉及。 |
datastore_name | String | 参数解释: 数据库名称。 取值范围:
|
created | String | 参数解释: 创建时间。 取值范围: 格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800 |
updated | String | 参数解释: 更新时间。 取值范围: 格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800 |
mode | String | 参数解释: 数据库实例类型。 取值范围:
|
user_defined | Boolean | 参数解释: 是否是用户自定义参数模板。 取值范围:
|
请求示例
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
} ]
} 状态码
请参见状态码。
错误码
请参见错误码。

