Obtaining Parameter Templates

Function

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

This API will be unavailable. You are advised to use the new API (Obtaining Parameter Templates) before then.

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

URI format
GET /v3/{project_id}/configurations
URI example
https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations

Required parameters

**Table 1** Parameter description
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
datastore_name	No	String	Explanation: Database name Constraints: N/A 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. Default value: If this parameter is not transferred, all database types are queried.
mode	No	String	Explanation: DB instance type Constraints: N/A 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. Default value: If this parameter is not transferred, the parameter group of instances with classic storage is queried.

Request Parameters

None

Response Parameters

Normal response

**Table 3** Parameter description
Parameter	Type	Description
count	Integer	Total number of records.
configurations	Array of objects	Parameter templates For details, see Table 4.

**Table 4** Data structure description of parameter **configurations**
Parameter	Type	Description
id	String	Parameter template ID.
name	String	Parameter template name.
description	String	Parameter template description.
datastore_version_name	String	Database version name.
datastore_name	String	Database name
created	String	Creation time in the yyyy-MM-ddTHH:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.
updated	String	Update time in the yyyy-MM-ddTHH:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.
user_defined	Boolean	Whether the parameter template is a custom template. The value can be: false: indicates that the parameter template is a default parameter template. true: indicates that the parameter template is a custom template.

Example normal response

{ 
    "count": 2,
    "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", 
            "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": "2020-03-21T03:38:51+0000", 
            "updated": "2019-03-21T03:38:51+0000", 
            "user_defined": false 
        } 
    ] 
}