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 instance types:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx instances with classic storage
GeminiDB Redis instances with classic storage

URI

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

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Explanation: Index offset. Constraints: N/A Values: 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	Explanation: Maximum number of instances that can be queried. Constraints: N/A Values: 1 to 100 Default value: If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

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

Response Parameters

Status code: 200

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

**Table 5** ListConfigurationsResult
Parameter	Type	Description
id	String	Explanation: Parameter template ID. Values: N/A
name	String	Explanation: Parameter template name. Values: N/A
description	String	Explanation: Parameter template description. Values: N/A
datastore_version_name	String	Explanation: Database version name. Values: N/A
datastore_name	String	Explanation: Database name. Values: 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	Explanation: Creation time Values: 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	Explanation: Update time Values: 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	Explanation: Instance type Values: 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. 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	Explanation: Whether a parameter template is created by users Values: false: default template true: custom template

Example Request

URI example

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

Example Response

Status code: 200

Successful request

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