更新时间:2024-12-11 GMT+08:00
分享

创建参数模板

功能介绍

创建参数模板信息,包含参数模板名称、描述、数据库版本信息、参数值。

接口约束

  • 该接口支持TaurusDB主备-独享版。

  • 创建参数模板的名称“name”不能与默认参数模板或已有参数模板的名称重复,并且区分大小写。

  • 创建参数模板的“parameter_values”参数必须在指定数据库版本的默认参数范围内。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us

  • zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数模板名称。

取值范围:长度1到64个字符之间,区分大小写字母,可包含字母、数字、中划线、下划线或句点,不能包含其他特殊字符。

description

String

参数模板描述。默认为空。

取值范围:长度不超过256个字符,且不能包含回车和特殊字符 ! < " = ' > &。

parameter_values

Map<String,String>

参数名和参数值映射关系。用户可以基于默认参数模板的参数,自定义的参数值。

datastore

DatastoreResult object

数据库对象。

表4 DatastoreResult

参数

是否必选

参数类型

描述

type

String

数据库引擎,现在只支持gaussdb-mysql。

version

String

数据库版本。数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

configurations

ConfigurationSummary2 object

参数模板信息。

表6 ConfigurationSummary2

参数

参数类型

描述

id

String

参数组ID。

name

String

参数组名称。

description

String

参数组描述。

datastore

DatastoreResult object

数据库对象。

created

String

创建时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中,T指某个时间的开始;Z指时区偏移量。

updated

String

更新时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中,T指某个时间的开始;Z指时区偏移量。

表7 DatastoreResult

参数

参数类型

描述

type

String

数据库引擎,现在只支持gaussdb-mysql。

version

String

数据库版本。数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

创建参数模板,账户允许最大同时连接数为10。

POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations

{
  "name" : "myparameter",
  "description" : "parameter1",
  "datastore" : {
    "type" : "gaussdb-mysql",
    "version" : "8.0"
  },
  "parameter_values" : {
    "max_user_connections" : "10"
  }
}

响应示例

状态码: 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代码示例

SDK代码示例如下。

Java

创建参数模板,账户允许最大同时连接数为10。

 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());
        }
    }
}

Python

创建参数模板,账户允许最大同时连接数为10。

 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)

Go

创建参数模板,账户允许最大同时连接数为10。

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

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档