Obtaining Parameter Templates_Parameter Configuration_APIs v3.1_API Reference

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 Influx

URI

GET /v3.1/{project_id}/configurations

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data. The value must be a non-negative number.
limit	No	Integer	Maximum number of instances that can be queried. The value ranges from 1 to 100. 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	User token.

Response Parameters

Status code: 200

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

**Table 5** ListConfigurationsResult
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.
mode	String	Instance type. The value can be: Cluster: GeminiDB Cassandra cluster instance Cluster: GeminiDB Influx cluster instance InfluxdbSingle: single-node GeminiDB Influx instance
user_defined	Boolean	Whether the parameter template is a custom template. The value can be: false, indicating that the parameter template is a default parameter template. true, indicating that the parameter template is a custom template.

Example Request

URI example

GET https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&limit=10

Example Response

Status code: 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
  } ]
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Obtaining Parameter Templates