Obtaining Parameter Templates

Function

This API is used to obtain parameter templates, including all of the default and custom parameter templates.

Constraints

This API supports the following instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx
GeminiDB Redis

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:configuration:list	List	-	-	nosql:param:list	-

URI

GET /v3.1/{project_id}/configurations

**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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
user_defined	No	Boolean	Definition Whether a value is user-defined Constraints N/A Range N/A Default Value false
name	No	String	Definition Parameter template name Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Index offset. Constraints N/A Range If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data. The value must be a non-negative number. Default Value The default value is 0, indicating that the query starts from the first data record.
limit	No	Integer	Definition Maximum number of instances that can be queried. Constraints N/A Range 1 to 100 Default Value If this parameter is not transferred, the first 100 records are queried by default.
datastore_name	No	String	Definition Database name. Constraints Unlimited Range cassandra: GeminiDB Cassandra instances are supported. redis: GeminiDB Redis instances are supported. influxdb: GeminiDB Influx instances are supported. mongodb: GeminiDB Mongo instances are supported. Default Value If this parameter is not transferred, all database types are queried.
mode	No	String	Definition Instance type. The value can be: Constraints Unlimited Range Cluster: GeminiDB Cassandra or GeminiDB Influx cluster instance with classic storage; proxy cluster GeminiDB Redis instance with classic storage CloudNativeCluster: GeminiDB Cassandra, Influx, or Redis cluster instance with cloud native storage RedisCluster: Redis Cluster GeminiDB Redis instance with classic storage Replication: primary/standby GeminiDB Redis instance with classic storage InfluxdbSingle: single-node GeminiDB Influx instance with classic storage EnhancedCluster: GeminiDB Influx cluster (performance-enhanced) instance with classic storage ReplicaSet: GeminiDB Mongo instance in a replica set All: parameter templates of instance with all storage types Default Value If this parameter is not transferred, the parameter group of instances with classic storage is queried.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Definition Total number of records. Range N/A
quota	Integer	Definition Maximum number of custom parameter templates that a user can create. Range N/A
configurations	Array of ListConfigurationsResult objects	Definition Parameter templates. Range N/A

**Table 5** ListConfigurationsResult
Parameter	Type	Description
id	String	Definition Parameter template ID. Range N/A
name	String	Definition Parameter template name. Range N/A
description	String	Definition Parameter template description. Range N/A
datastore_version_name	String	Definition Database version name. Range N/A
datastore_name	String	Definition Database name. Range cassandra: GeminiDB Cassandra instances are supported. redis: GeminiDB Redis instances are supported. influxdb: GeminiDB Influx instances are supported. mongodb: GeminiDB Mongo instances are supported.
created	String	Definition Creation time Range Format: yyyy-MM-ddTHH:mm:ssZ T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.
updated	String	Definition Update time Range Format: yyyy-MM-ddTHH:mm:ssZ T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.
mode	String	Definition Instance type Range CloudNativeCluster: The parameter template of a GeminiDB Cassandra instance with cloud native storage is queried. Cluster: The parameter template of a cluster GeminiDB Cassandra instance with classic storage, a cluster GeminiDB Influx instance with classic storage, or a proxy cluster GeminiDB Redis instance with classic storage is queried. InfluxdbSingle: The parameter template of a single-node GeminiDB Influx instance with classic storage is queried. EnhancedCluster: GeminiDB Influx cluster (performance-enhanced) instance with classic storage ReplicaSet: The parameter group of GeminiDB Mongo instances in a replica set is queried. All: Parameter templates of instance with all storage types are queried.
user_defined	Boolean	Definition Whether a parameter template is created by users Range false: default template true: custom template

Example Requests

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&limit=10

Example Responses

Status code: 200

Successful response

{
  "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
  } ]
}