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
- 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.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependency
gaussdbformysql:param:create
Write
-
-
gaussdb:param:create
-
URI
POST /v3/{project_id}/configurations
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition 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 N/A Range N/A Default Value N/A |
|
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range Default Value en-us |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
Definition Parameter template name. Constraints N/A Range The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. Default Value N/A |
|
description |
No |
String |
Definition Parameter template description. Constraints N/A 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> |
Definition Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template. Constraints N/A |
|
datastore |
No |
DatastoreResult object |
Definition Database object. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
Yes |
String |
Definition DB engine. Constraints N/A Range Only gaussdb-mysql is supported. Default Value N/A |
|
version |
Yes |
String |
Definition Database version. For details about how to obtain the version, see the name field returned in Querying Version Information About a DB Engine. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
configurations |
ConfigurationSummary2 object |
Parameter template information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Definition Parameter template ID. Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. |
|
name |
String |
Definition Parameter template name. Range The value is the same as the parameter template name in the request. |
|
description |
String |
Definition Parameter template description. Range The value is the same as the parameter template description in the request. |
|
datastore |
DatastoreResult object |
Definition Database object. |
|
created |
String |
Definition 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. Range N/A |
|
updated |
String |
Definition 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. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
String |
Definition DB engine. Constraints N/A Range Only gaussdb-mysql is supported. Default Value N/A |
|
version |
String |
Definition Database version. For details about how to obtain the version, see the name field returned in Querying Version Information About a DB Engine. Constraints N/A Range N/A Default Value N/A |
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"
}
}
SDK Sample Code
The SDK sample code is as follows.
Creating a parameter template (There are up to 10 concurrent connections for the account.)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; import java.util.Map; import java.util.HashMap; public class CreateGaussMySqlConfigurationSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); CreateGaussMySqlConfigurationRequest request = new CreateGaussMySqlConfigurationRequest(); CreateConfigurationRequestBody body = new CreateConfigurationRequestBody(); DatastoreResult datastorebody = new DatastoreResult(); datastorebody.withType("gaussdb-mysql") .withVersion("8.0"); Map<String, String> listbodyParameterValues = new HashMap<>(); listbodyParameterValues.put("max_user_connections", "10"); body.withDatastore(datastorebody); body.withParameterValues(listbodyParameterValues); body.withDescription("parameter1"); body.withName("myparameter"); request.withBody(body); try { CreateGaussMySqlConfigurationResponse response = client.createGaussMySqlConfiguration(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Creating a parameter template (There are up to 10 concurrent connections for the account.)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateGaussMySqlConfigurationRequest() datastorebody = DatastoreResult( type="gaussdb-mysql", version="8.0" ) listParameterValuesbody = { "max_user_connections": "10" } request.body = CreateConfigurationRequestBody( datastore=datastorebody, parameter_values=listParameterValuesbody, description="parameter1", name="myparameter" ) response = client.create_gauss_my_sql_configuration(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a parameter template (There are up to 10 concurrent connections for the account.)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateGaussMySqlConfigurationRequest{} datastorebody := &model.DatastoreResult{ Type: "gaussdb-mysql", Version: "8.0", } var listParameterValuesbody = map[string]string{ "max_user_connections": "10", } descriptionCreateConfigurationRequestBody:= "parameter1" request.Body = &model.CreateConfigurationRequestBody{ Datastore: datastorebody, ParameterValues: listParameterValuesbody, Description: &descriptionCreateConfigurationRequestBody, Name: "myparameter", } response, err := client.CreateGaussMySqlConfiguration(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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