文档首页/ 分布式缓存服务 DCS/ API参考（巴黎区域）/ API V2（推荐）/ 模板管理/ 创建自定义模板
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

创建自定义模板

功能介绍

创建自定义模板

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：用户自定义模板

枚举值：

  • sys

  • user

engine

否

String

缓存引擎：Redis和Memcached。

cache_mode

否

String

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

  • single：表示单机实例

  • ha：表示主备实例

  • cluster：表示cluster集群实例

  • proxy：表示Proxy集群实例

description

否

String

模板的描述信息。

engine_version

否

String

缓存版本。

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

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

params

是

Map<String,String>

参数配置信息。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

模板ID。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

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

最大长度：1024

请求示例

创建一个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."
}

状态码

状态码

描述

200

创建自定义模板成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 模板管理