文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 参数管理/ 创建参数模板
更新时间：2025-06-13 GMT+08:00
查看PDF
分享

创建参数模板

功能介绍

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

调试

您可以在API Explorer中调试该接口。

接口约束

  • 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。
  • 创建参数模板的name名称不能与默认参数模板或已有参数模板的名称重复。

URI

  • URI格式

    POST /v3/{project_id}/configurations

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一Region下的项目ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

name

是

String

参数解释：

参数模板名称。

约束限制：

最长64个字符，只允许大写字母、小写字母、数字、和“-_.”特殊字符。

取值范围：

不涉及。

默认取值：

不涉及。

datastore

是

Object

参数解释：

数据库对象。

详情请参见表3。

约束限制：

不涉及。

description

否

String

参数解释：

参数模板描述。

约束限制：

最长256个字符，不支持>!<"&'=特殊字符。默认为空。

取值范围：

不涉及。

默认取值：

不涉及。

values

否

Map<String,String>

参数解释：

参数值对象，用户基于默认参数模板自定义的参数值。

约束限制：

不涉及。

取值范围：

  • key：参数名称，如“div_precision_increment”，“connect_timeout”。为空时不修改参数值。
  • value：参数值，如“6”，“20”。key不为空时value也不可为空。

默认取值：

默认不修改参数值。
表3 datastore字段数据结构说明

名称

是否必选

参数类型

说明

type

是

String

参数解释：

数据库引擎。

约束限制：

不区分大小写。

取值范围：

  • MySQL
  • PostgreSQL
  • SQLServer

默认取值：

不涉及。

version

是

String

参数解释：

数据库版本。

约束限制：

详见接口约束。

取值范围：
  • MySQL：取值示例：5.7。
  • PostgreSQL：取值示例：12。
  • Microsoft SQL Server：取值示例：2014_SE。

默认取值：

不涉及。

请求示例

创建参数模板configuration_test。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations
{
	"name": "configuration_test",
	"description": "configuration_test",
	"values": {
                "div_precision_increment": "6",
                "connect_timeout": "20"
	},
	"datastore": {
		"type": "mysql",
		"version": "5.7"
	}
}

响应消息

  • 正常响应要素说明
    表4 要素说明

    名称

    参数类型

    说明

    configuration

    Object

    参数解释：

    参数模板信息。

    详情请参见表5。
    表5 configuration字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    参数解释：

    参数模板ID。

    取值范围：

    不涉及。

    name

    String

    参数解释：

    参数模板名称。

    取值范围：

    不涉及。

    datastore_version_name

    String

    参数解释：

    数据库版本名称。

    取值范围：

    不涉及。

    datastore_name

    String

    参数解释：

    数据库名称。

    取值范围：

    不涉及。

    description

    String

    参数解释：

    描述。

    取值范围：

    不涉及。

    created

    String

    参数解释：

    创建时间。

    取值范围：

    格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

    updated

    String

    参数解释：

    更新时间。

    取值范围：

    格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  • 正常响应样例 
    {
	"configuration": {
		"id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
		"name": "configuration_test",
		"datastore_version_name": "5.7",
		"datastore_name": "mysql",
		"description": "configuration_test",
		"created": "2017-04-09T08:27:56+0800",
		"updated": "2017-04-09T08:27:56+0800"
                
	}
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 参数管理

相关文档