创建参数模板

功能介绍

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

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

接口约束

• 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。

• 创建参数模板的name名称不能与默认参数模板或已有参数模板的名称重复。

URI

• URI格式

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

• URI样例

  https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。

请求消息

• 参数说明

  表2 参数说明

  名称	是否必选	参数类型	说明
  name	是	String	参数模板名称。最长64个字符，只允许大写字母、小写字母、数字、和“-_.”特殊字符。
  description	否	String	参数模板描述。最长256个字符，不支持>!<"&'=特殊字符。默认为空。
  values	否	Map<String,String>	参数值对象，用户基于默认参数模板自定义的参数值。默认不修改参数值。 详情请参见表3。
  datastore	是	Object	数据库对象。 详情请参见表4。

  表3 values字段数据结构说明

  名称	是否必选	参数类型	说明
  key	否	String	参数名称，"max_connections":"10"。为空时不修改参数值，key不为空时value也不可为空。
  value	否	String	参数值，"max_connections":"10"。

  表4 datastore字段数据结构说明

  名称	是否必选	参数类型	说明
  type	是	String	数据库引擎，不区分大小写： MySQL PostgreSQL SQLServer
  version	是	String	数据库版本，详见接口约束： MySQL：取值示例：5.7。 PostgreSQL：取值示例：9.5。

• 请求样例

  {
  	"name": "configuration_test",
  	"description": "configuration_test",
  	"values": {
  		"max_connections": "10",
  		"autocommit": "OFF"
  	},
  	"datastore": {
  		"type": "mysql",
  		"version": "5.6"
  	}
  }

响应消息

• 正常响应要素说明

  表5 要素说明

  名称	参数类型	说明
  configuration	Object	参数模板信息。 详情请参见表6。

  表6 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.6",
  		"datastore_name": "mysql",
  		"description": "configuration_test",
  		"created": "2017-04-09T08:27:56+0800",
  		"updated": "2017-04-09T08:27:56+0800"
  	}
  }

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。