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 only available for cluster TaurusDB 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 |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints: None Value range: None Default value: None |
X-Language |
No |
String |
Explanation: Request language type. Constraints: None Value range: Default value: en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Explanation: Parameter template name. Constraints: None Value range: The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. Default value: None |
description |
No |
String |
Explanation: Parameter template description. Constraints: None Value range: The description can consist of up to 256 characters. It cannot contain carriage returns or any of the following special characters: !<"='>& Default value: Empty |
parameter_values |
No |
Map<String,String> |
Explanation: Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template. Constraints: None |
datastore |
No |
DatastoreResult object |
Explanation: Database object. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Explanation: DB engine. Constraints: None Value range: Only gaussdb-mysql is supported. Default value: None |
version |
Yes |
String |
Explanation: Database version. For details about how to obtain the version, see the name field returned in Querying Version Information About a DB Engine. Constraints: None Value range: None Default value: None |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
configurations |
ConfigurationSummary2 object |
Parameter template information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Explanation: Parameter template ID. Value range: The value can contain 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. |
name |
String |
Explanation: Parameter template name. Value range: The value is the same as the parameter template name in the request. |
description |
String |
Explanation: Parameter template description. Value range: The value is the same as the parameter template description in the request. |
datastore |
DatastoreResult object |
Explanation: Database object. |
created |
String |
Explanation: Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Value range: None |
updated |
String |
Explanation: Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Value range: None |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Explanation: DB engine. Constraints: None Value range: Only gaussdb-mysql is supported. Default value: None |
version |
String |
Explanation: Database version. For details about how to obtain the version, see the name field returned in Querying Version Information About a DB Engine. Constraints: None Value range: None Default value: None |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot