Updated on 2026-05-30 GMT+08:00

Creating a Parameter Template (a V3 API)

Function

This API is used to create a parameter template.

URI

POST /v3/{project_id}/configurations

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Parameter template name

The parameter template name can contain 1 to 64 characters. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

description

Yes

String

Parameter template description

The value can contain a maximum of 256 characters and cannot contain carriage return characters or the following special characters ! < " = ' > &

If the description contains more than 256 characters, the parameter group can still be created. The first 256 characters will be automatically used.

values

No

Map<String,String>

Definition

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

Constraints

N/A

Range

  • key: parameter name, for example, contains_shard_key or connection_idle_timeout. If this parameter is not specified, no parameter value is to be changed.

  • value: parameter value, for example, 6 or 20. If key is not empty, the parameter value cannot be empty, either.

Default Value

N/A

Example Request

Creating a parameter template

POST https://{endpoint}/v3/{project_id}/configurations
{
  "name" : "param1688972688",
  "description" : "test"
}

Response Parameters

  • Normal response
Table 4 Response body parameters

Parameter

Type

Description

id

String

Parameter template ID

name

String

Name

Example Response

  • Normal response example
{
  "id": "404f3bbb8a724f7697e7fb15a1b09370pr09",
  "name": "param1688972688"
}

Status Codes

Error Codes

For details, see Error Codes.