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 on March 31, 2025. You are advised to switch workloads to the new API (Obtaining Parameter Templates) before then.

Constraints

This API supports the following types of instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx

URI

URI format
GET https://{Endpoint}/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	Description
project_id	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Request Parameters

None

Response Parameters

Normal response

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

**Table 3** 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 
        } 
    ] 
}