Updated on 2024-11-06 GMT+08:00

Creating a Custom Template

Function

This API is used to create a custom template.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/config-templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

template_id

Yes

String

Default template ID.

name

Yes

String

Template name.

type

Yes

String

Template type. Options:

  • sys: default template

  • user: custom template

engine

No

String

Cache engine: Redis or Memcached.

cache_mode

No

String

DCS instance type. The value range is as follows:

  • single: single-node

  • ha: master/standby

  • cluster: Redis Cluster

  • proxy: Proxy Cluster

  • ha_rw_split: read/write splitting

description

No

String

Template description.

engine_version

No

String

Cache version.

If the cache engine is Redis, the version can be 4.0/5.0/6.0.

If the cache engine is Memcached, this parameter is optional and can be left blank.

params

Yes

Map<String,String>

Parameter configuration.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Template ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error information.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error information.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error information.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error information.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Error information.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Example Requests

Creating a single-node, Redis 5.0 custom template

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

Example Responses

Status code: 200

The custom template is created successfully.

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

Status code: 400

Invalid request.

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

SDK Sample Code

The SDK sample code is as follows.

Creating a single-node, Redis 5.0 custom template

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

Creating a single-node, Redis 5.0 custom template

 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)

Creating a single-node, Redis 5.0 custom template

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The custom template is created successfully.

400

Invalid request.

401

Invalid authentication information.

403

Request rejected.

404

The requested resource could not be found.

500

Internal service error.

Error Codes

See Error Codes.