获取参数模板列表
功能介绍
获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。
接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
URI
GET https://{Endpoint}/v3.1/{project_id}/configurations
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。获取方法请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
索引位置，偏移量。
|
limit |
否 |
Integer |
查询个数上限值。
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户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指时区偏移量。 |
updated |
String |
更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量。 |
mode |
String |
数据库实例类型。 GeminiDB Cassandra集群类型为"Cluster"。 GeminiDB Mongo副本集类型为"ReplicaSet"。 GeminiDB Mongo集群类型为"Sharding"。 GeminiDB Influx集群类型为"Cluster"。 GeminiDB Influx单节点类型为"InfluxdbSingle"。 |
user_defined |
Boolean |
是否是用户自定义参数模板：
|
请求示例
GET https://gaussdb-nosql.ap-southeast-1.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
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。
