Creating a Parameter Template
Function
This API is used to create a parameter template. The following information needs to be configured: template name, description, DB engine version, and parameter values. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
Constraints
- This API is available only for GaussDB(for MySQL) primary/standby instances (dedicated edition).
- The name of the custom parameter template is case-sensitive and must be different from the name of an existing or a default parameter template.
- The value of parameter_values in the custom parameter template must be within the default value range of the specified database version.
URI
POST /v3/{project_id}/configurations
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Parameter template name. Value: The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. |
description |
No |
String |
Parameter template description. The value is left blank by default. Value: The description can consist of up to 256 characters, and cannot contain the carriage return characters or special characters (!<"='>&). |
parameter_values |
No |
Map<String,String> |
Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template. |
datastore |
No |
DatastoreResult object |
Database object. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
DB engine. Currently, only gaussdb-mysql is supported. |
version |
Yes |
String |
DB version. For details about supported DB versions, see Querying Version Information About a DB Engine. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
configurations |
ConfigurationSummary2 object |
Parameter template information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Parameter template ID. |
name |
String |
Parameter template name. |
description |
String |
Parameter template description. |
datastore |
DatastoreResult object |
Database object. |
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. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
DB engine. Currently, only gaussdb-mysql is supported. |
version |
String |
DB version. For details about supported DB versions, see Querying Version Information About a DB Engine. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
Creating a parameter template (There are up to 10 concurrent connections for the account.)
POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations { "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "parameter_values" : { "max_user_connections" : "10" } }
Example Response
Status code: 200
Success.
{ "configurations" : { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "created" : "2022-05-15T11:53:34+0000", "updated" : "2022-05-15T11:53:34+0000" } }
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.