# 创建参数模板 - CreatingaParameterTemplate #### 功能介绍 创建参数模板。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=CreateConfigurationTemplate)中调试该接口。 #### URI POST /v3/{project_id}/configurations 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 参数模板名称。 **约束限制：** 不可重复。 **取值范围：** 长度1\~64位之间，区分大小写字母，可包含字母、数字、中划线、下划线或句点，不能包含其他特殊字符。 **默认取值：** 不涉及。 | | description | 否 | String | **参数解释：** 参数模板描述。 **约束限制：** 不涉及。 **取值范围：** 长度超过256自动截取，不能包含回车\>!\<"\&'=等特殊字符。 **默认取值：** 空。 | | parameter_values | 否 | Map\ | **参数解释：** 参数名和参数值映射关系。用户可以基于默认参数模板的参数，自定义参数值。 **约束限制：** 不涉及。 | | datastore | 是 | object | **参数解释：** 数据库引擎信息。可通过[查询数据库引擎的版本](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_083.html)接口查询。详情请参见[表4]。 **约束限制：** 不涉及。 | 表4datastore参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | engine_version | 是 | String | **参数解释：** 数据库版本。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_mode | 是 | String | **参数解释：** 部署形态。 **约束限制：** 不涉及。 **取值范围：** - **ha**：集中式版。 - **ha:readonly**：集中式版只读节点。 - **independent**：分布式版独立部署。 **默认取值：** 不涉及。 | #### 响应参数 表5参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 参数模板ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 参数模板名称。 **取值范围：** 不涉及。 | | created_at | String | **参数解释：** 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | #### 请求示例 - 创建一个2.3版本，集中式版部署形态的参数模板。 ``` POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations { "name": "paramTemplate", "description": "", "parameter_values": { "audit_system_object": "12294" }, "datastore": { "engine_version": "2.3", "instance_mode": "ha" } } ``` - 创建一个2.3版本，分布式版独立部署形态，多个自定义参数的参数模板。 ``` POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations { "name": "paramTemplate", "description": "", "parameter_values": { "audit_system_object": "12294", "dn:effective_cache_size": "262143", "checkpoint_segments": "2048" }, "datastore": { "engine_version": "2.3", "instance_mode": "independent" } } ``` #### 响应示例 创建参数模板成功。 ``` { "id" : "137eeaf0cc884ca4adffa9ebd101c115pr14", "name" : "paramTemplate-del", "created_at" : "2022-08-09T03:06:52+0800" } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。