Updated on 2025-09-23 GMT+08:00

Creating a Parameter Template

Function

This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.

Constraints

This API supports the following instance types:

  • GeminiDB Cassandra
  • GeminiDB Influx

The new parameter template cannot have the same name as any existing parameter template.

For configuration item values, you can enter system-defined parameters that allow for modification.

URI

POST /v3/{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.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Parameter template name. It can include a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).

description

No

String

Parameter template description. It can contain a maximum of 256 characters except the following special characters: >!<"&'= The value is left blank by default.

values

No

Map<String,String>

Parameter values defined by users based on a default parameter template. Keep the parameter values unchanged by default.

datastore

Yes

ConfigurationDatastoreOption object

Database object.

Table 4 ConfigurationDatastoreOption

Parameter

Mandatory

Type

Description

type

Yes

String

Database type. The value can be:

cassandra: GeminiDB Cassandra instance

influxdb: GeminiDB Influx instance

version

Yes

String

Database version. The value can be:

3.11: GeminiDB Cassandra instance 3.11

1.7, indicating that GeminiDB Influx 1.7 is supported.

mode

No

String

Instance type. This parameter is mandatory when you create a GeminiDB Cassandra instance with cloud native storage.

  • InfluxdbSingle: single-node GeminiDB Influx instance
  • CloudNativeCluster: GeminiDB Cassandra instance with cloud native storage

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

configuration

ConfigurationResult object

Parameter template information.

Table 6 ConfigurationResult

Parameter

Type

Description

id

String

Parameter template ID.

name

String

Parameter template name.

datastore_version_name

String

Database version name.

datastore_name

String

Database name.

description

String

Parameter template description

created

String

Creation time in the yyyy-MM-ddTHH:mm:ssZ format.

updated

String

Update time in the yyyy-MM-ddTHH:mm:ssZ format.

Example Request

  • URI example
    POST https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations
  • Creating a parameter template for GeminiDB Cassandra instances
    {
      "name" : "configuration_test",
      "description" : "configuration_test",
      "values" : {
        "max_connections" : "10",
        "autocommit" : "OFF"
      },
      "datastore" : {
        "type" : "cassandra",
        "version" : "3.11"
      }
    }

Example Response

Status code: 200

Success

{
  "configuration" : {
    "id" : "463b4b58d0e84e2b95605dea4552fdpr06",
    "name" : "configuration_test",
    "datastore_version_name" : "3.11",
    "datastore_name" : "cassandra",
    "description" : "configuration_test",
    "created" : "2020-03-09T08:27:56+0800",
    "updated" : "2020-03-09T08:27:56+0800"
  }
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.