文档首页/ 分布式缓存服务 DCS/ API参考 (联盟区域) / API V2（推荐）/ 模板管理/ 查询参数模板列表
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询参数模板列表

功能介绍

查询租户的参数模板列表，支持按照条件查询。

URI

GET /v2/{project_id}/config-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

参数模板名称，支持模糊查找。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

是

String

参数解释：

模板类型。

约束限制：

不涉及。

取值范围：

  • sys：系统默认模板。

  • user：用户自定义模板。

默认取值：

不涉及。

engine

否

String

参数解释：

缓存引擎。

约束限制：

不涉及。

取值范围：

  • Redis

  • Memcached

默认取值：

不涉及。

engine_version

否

String

参数解释：

缓存版本。

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

cache_mode

否

String

参数解释：

缓存实例类型。

约束限制：

不涉及。

取值范围：

  • single：表示单机实例

  • ha：表示主备实例

  • cluster：表示cluster集群实例

  • proxy：表示Proxy集群实例

  • ha_rw_split：表示读写分离实例

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示条数。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

template_num

Integer

参数解释：

模板个数。

取值范围：

不涉及。

templates

Array of ConfigTemplatesListInfo objects

参数解释：

模板的详情数组。

取值范围：

不涉及。
表4 ConfigTemplatesListInfo

参数

参数类型

描述

template_id

String

参数解释：

模板ID。

取值范围：

不涉及。

cache_mode

String

参数解释：

缓存实例类型。

取值范围：

  • single：表示单机实例

  • ha：表示主备实例

  • cluster：表示cluster集群实例

  • proxy：表示Proxy集群实例

  • ha_rw_split： 表示读写分离实例

description

String

参数解释：

模板的描述信息。

取值范围：

不涉及。

engine

String

参数解释：

缓存引擎。

取值范围：

  • Redis

  • Memcached

engine_version

String

参数解释：

缓存版本。

取值范围：

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

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

name

String

参数解释：

模板名称。

取值范围：

不涉及。

product_type

String

参数解释：

产品类型。

取值范围：

目前仅支持基础版，取值为：generic。

storage_type

String

参数解释：

存储类型。

取值范围：

  • DRAM：内存型。

  • SSD：存储型。

type

String

参数解释：

模板类型。

取值范围：

  • sys：系统默认模板。

  • user：用户自定义模板。

created_at

String

参数解释：

模板创建的时间，仅在自定义参数模板中有意义，格式：2023-05-10T11:09:35.802Z。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/config-templates?type=sys&engine=Redis&engine_version=5.0&cache_mode=ha&offset=0&limit=10

响应示例

状态码：200

查询参数模板列表成功。

{
  "template_num" : 1,
  "templates" : [ {
    "template_id" : "6",
    "cache_mode" : "single",
    "description" : null,
    "engine" : "Redis",
    "engine_version" : "4.0",
    "name" : "Default-Redis-4.0-single-generic-DRAM",
    "product_type" : "generic",
    "storage_type" : "DRAM",
    "type" : "sys"
  } ]
}

状态码：400

非法请求。

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

状态码

状态码

描述

200

查询参数模板列表成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 模板管理