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 Mongo
GeminiDB Influx
GeminiDB Redis instances with classic storage

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.

Authorization

Each account is authorized to call all APIs, but its IAM users must be granted necessary permissions. For details, see Permission Policies and Supported Actions.

URI

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

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Explanation: Parameter template name Constraints: The name can contain a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.). Values: N/A Default value: N/A
description	No	String	Explanation: Parameter template description Constraints: The description can contain a maximum of 256 characters except the following special characters: >!<"&'= N/A Values: N/A Default value: Empty
values	No	Map<String,String>	Explanation: Parameter values defined by users based on a default parameter template Constraints: N/A Values: N/A Default value: Keep the parameter values unchanged by default.
datastore	Yes	ConfigurationDatastoreOption object	Explanation: Database object. Constraints: N/A Values: N/A Default value: N/A
instance_id	No	String	Explanation: Instance ID, which can be obtained by following Querying Instances and Details. If no instance is available, call the API by flowing Creating an Instance to create one. If this parameter is specified, the parameter template will be created based on the instance information. Constraints: N/A Values: N/A Default value: N/A

**Table 4** ConfigurationDatastoreOption
Parameter	Mandatory	Type	Description
type	Yes	String	Explanation: Database type Constraints: N/A Values: cassandra: GeminiDB Cassandra instance mongodb: GeminiDB Mongo instance influxdb: GeminiDB Influx instance redis: GeminiDB Redis instance dynamodb: GeminiDB DynamoDB-Compatible instance hbase: GeminiDB HBase instance Default value: N/A
version	Yes	String	Explanation: Database version Constraints: N/A Values: 3.11: GeminiDB Cassandra instance 3.11 4.0: GeminiDB Mongo instance 4.0 1.8: GeminiDB Influx instance 1.8 5.0: GeminiDB Redis instance 5.0 Default value: N/A
mode	No	String	Explanation: DB instance type Constraints: This parameter is mandatory when you create a GeminiDB Mongo or GeminiDB Cassandra instance with cloud native storage. Values: ReplicaSet, indicating that the instance is a GeminiDB Mongo replica set. InfluxdbSingle, indicating that the instance is a single-node GeminiDB Influx instance. EnhancedCluster: GeminiDB Influx instance in a performance-enhanced cluster CloudNativeCluster: GeminiDB Influx instance with cloud native storage CloudNativeCluster: GeminiDB Cassandra instance with cloud native storage CloudNativeCluster: GeminiDB Redis instance with cloud native storage Default value: If this parameter is not transferred, the parameter template of a GeminiDB Cassandra instance with classic storage is queried by default.

Response Parameters

Status code: 200

**Table 5** Response body parameter
Parameter	Type	Description
configuration	ConfigurationResult object	Explanation: Parameter template information Values: N/A

**Table 6** ConfigurationResult
Parameter	Type	Description
id	String	Explanation: Parameter template ID Values: N/A
name	String	Explanation: Parameter template name Values: N/A
datastore_version_name	String	Explanation: Database version name Values: N/A
datastore_name	String	Explanation: Database name Values: N/A
description	String	Explanation: Parameter template description Values: N/A
created	String	Explanation: Creation time Values: Format: yyyy-MM-ddTHH:mm:ssZ
updated	String	Explanation: Update time Values: Format: yyyy-MM-ddTHH:mm:ssZ
mode	String	Explanation: DB instance type Values: ReplicaSet: GeminiDB Mongo instances in a replica set InfluxdbSingle: single-node GeminiDB Influx instance EnhancedCluster: GeminiDB Influx instance in a performance-enhanced cluster CloudNativeCluster: GeminiDB Influx instance with cloud native storage CloudNativeCluster: GeminiDB Redis instance with cloud native storage CloudNativeCluster: GeminiDB Cassandra instance with cloud native storage

Example Request

URI example

POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/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"
  }
}

Creating a parameter template based on an existing instance ID

 { 
   "name" : "myparameter_for_influxdb", 
   "description" : "parameter1", 
   "instance_id" : "9136fd2a9fcd405ea4674276ce36dae8in02" 
 }

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