文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/参数配置/创建参数模板
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

创建参数模板

接口说明

创建参数模板信息，包含参数模板名称、描述、数据库版本信息、参数值。

约束说明

  • 该接口仅支持DDS社区版。
  • 创建参数模板的名称“name”不能与默认参数模板或已有参数模板的名称重复，并且区分大小写。
  • 创建参数模板的parameter_values参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《文档数据库服务用户指南》中“编辑参数模板”的内容。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/configurations

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 请求Body参数

参数

参数类型

是否必选

描述

name

String

是

参数模板名称。

取值范围：长度1到64位之间，区分大小写字母，可包含字母、数字、中划线、下划线或句点，不能包含其他特殊字符。

description

String

是

参数模板描述。默认为空。

取值范围：长度不超过256位，且不能包含回车和>!<"&'=特殊字符。

parameter_values

Map<String,String>

是

参数名和参数值映射关系。用户可以基于默认参数模板的参数，自定义的参数值。

datastore

Object

是

数据库对象。

请参见表4。

表4 datastore字段数据结构说明

名称

参数类型

是否必选

说明

node_type

String

是

node_type参数模板节点类型。取值范围：
  • mongos，表示集群mongos节点类型。
  • shard，表示集群shard节点类型。
  • config，表示集群config节点类型。
  • replica，表示副本集类型。
  • readonly，表示副本集只读节点类型。
  • shard_readonly，表示集群只读节点类型。
  • single，表示单节点类型。

version

String

是

数据库版本。支持4.4、4.2、4.0、3.4版本，取值为“4.4”、“4.2”、“4.0”、“3.4”。

  • 请求示例 
    { 
  "name" : "myparameter", 
  "description" : "parameter1", 
  "datastore" : { 
    "node_type" : "shard", 
    "version" : "3.4" 
  }, 
  "parameter_values" : { 
    "max_connections" : "10" 
  } 
}

响应参数

表5 configuration字段数据结构说明

名称

参数类型

说明

id

String

参数模板ID。

name

String

参数模板名称。

description

String

参数模板描述。

datastore_version

String

数据库版本。

datastore_name

String

数据库类型。

created

String

创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量。

updated

String

更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量。

  • 响应示例 
    {
  "configuration": {
    "id": "7b4e07852bd54016906e89461b3182cdpr02",
    "name": "myparameter",
    "description": "parameter1",
    "datastore_version": "3.4",
    "datastore_name": "mongodb",
    "created": "2018-09-19T02:54:21",
    "updated": "2018-09-19T02:54:21"
  }
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：参数配置