更新时间:2024-11-06 GMT+08:00

创建自定义模板

功能介绍

创建自定义模板。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/config-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

template_id

String

来源系统模板ID。

name

String

模板名称。

type

String

模板类型,取值范围:

  • sys:系统默认模板

  • user:用户自定义模板

engine

String

缓存引擎:Redis和Memcached。

cache_mode

String

缓存实例类型。取值范围如下:

  • single:表示单机实例

  • ha:表示主备实例

  • cluster:表示cluster集群实例

  • proxy:表示Proxy集群实例

  • ha_rw_split: 表示读写分离实例

description

String

模板的描述信息。

engine_version

String

缓存版本。

当缓存引擎为Redis时,取值为4.0/5.0/6.0。

当缓存引擎为Memcached时,该字段为可选,取值为空。

params

Map<String,String>

参数配置信息。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

模板ID。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

请求示例

创建一个Redis5.0单机实例的自定义模板。

POST https://{dcs_endpoint}/v2/{project_id}/config-templates

{
  "name" : "Test",
  "cache_mode" : "single",
  "description" : "Test",
  "engine" : "Redis",
  "engine_version" : "5.0",
  "params" : {
    "latency-monitor-threshold" : 15
  },
  "template_id" : "11",
  "type" : "sys"
}

响应示例

状态码: 200

创建自定义模板成功。

{
  "id" : "efb1ba06-d3cd-4a77-9173-16f70f2d1343"
}

状态码: 400

非法请求。

{
  "error_code" : "111400063",
  "error_msg" : "Invalid {0} parameter in the request."
}

SDK代码示例

SDK代码示例如下。

创建一个Redis5.0单机实例的自定义模板。

 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
61
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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;

import java.util.Map;
import java.util.HashMap;

public class CreateCustomTemplateSolution {

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

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateCustomTemplateRequest request = new CreateCustomTemplateRequest();
        CreateCustomTemplateBody body = new CreateCustomTemplateBody();
        Map<String, String> listbodyParams = new HashMap<>();
        listbodyParams.put("latency-monitor-threshold", "15");
        body.withParams(listbodyParams);
        body.withEngineVersion("5.0");
        body.withDescription("Test");
        body.withCacheMode("single");
        body.withEngine("Redis");
        body.withType("sys");
        body.withName("Test");
        body.withTemplateId("11");
        request.withBody(body);
        try {
            CreateCustomTemplateResponse response = client.createCustomTemplate(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());
        }
    }
}

创建一个Redis5.0单机实例的自定义模板。

 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 huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.v2 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 = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateCustomTemplateRequest()
        listParamsbody = {
            "latency-monitor-threshold": "15"
        }
        request.body = CreateCustomTemplateBody(
            params=listParamsbody,
            engine_version="5.0",
            description="Test",
            cache_mode="single",
            engine="Redis",
            type="sys",
            name="Test",
            template_id="11"
        )
        response = client.create_custom_template(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建一个Redis5.0单机实例的自定义模板。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/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 := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateCustomTemplateRequest{}
	var listParamsbody = map[string]string{
        "latency-monitor-threshold": "15",
    }
	engineVersionCreateCustomTemplateBody:= "5.0"
	descriptionCreateCustomTemplateBody:= "Test"
	cacheModeCreateCustomTemplateBody:= "single"
	engineCreateCustomTemplateBody:= "Redis"
	request.Body = &model.CreateCustomTemplateBody{
		Params: listParamsbody,
		EngineVersion: &engineVersionCreateCustomTemplateBody,
		Description: &descriptionCreateCustomTemplateBody,
		CacheMode: &cacheModeCreateCustomTemplateBody,
		Engine: &engineCreateCustomTemplateBody,
		Type: "sys",
		Name: "Test",
		TemplateId: "11",
	}
	response, err := client.CreateCustomTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

创建自定义模板成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码