Creating a Custom Template¶

Function¶

This API is used to create a custom template.

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 Enumeration values: sys user
engine	No	String	Cache engine: Redis.
cache_mode	No	String	DCS instance type. Options: single: single-node ha: master/standby cluster: Redis Cluster proxy: Proxy Cluster
description	No	String	Template description.
engine_version	No	String	Cache version. If the cache engine is Redis, the value can be 3.0, 4.0, 5.0, or 6.0.
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. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 401

**Table 5** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 403

**Table 6** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 404

**Table 7** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 500

**Table 8** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

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

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.

last updated: 2024-11-13 13:54 UTC - commit: 93bd43536502377606412af18143475372cf7df5