文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 参数模板管理> 创建参数模板
更新时间：2024-04-01 GMT+08:00
在线调试
CLI示例
查看PDF

创建参数模板

功能介绍

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

接口约束

  • 该接口支持GaussDB(for MySQL)主备-独享版。
  • 创建参数模板的名称“name”不能与默认参数模板或已有参数模板的名称重复，并且区分大小写。
  • 创建参数模板的“parameter_values”参数必须在指定数据库版本的默认参数范围内。

URI

POST /v3/{project_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数模板名称。

取值范围：

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

description

否

String

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

取值范围：

长度不超过256个字符，且不能包含回车和!<"='>&特殊字符。

parameter_values

否

Map<String,String>

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

datastore

否

DatastoreResult object

数据库对象。
表4 DatastoreResult

参数

是否必选

参数类型

描述

type

是

String

数据库引擎，仅支持gaussdb-mysql。

version

是

String

数据库版本。数据库支持的详细版本信息，可通过查询数据库引擎的版本获取。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

configurations

ConfigurationSummary2 object

参数模板信息。
表6 ConfigurationSummary2

参数

参数类型

描述

id

String

参数组ID。

name

String

参数组名称。

description

String

参数组描述。

datastore

DatastoreResult object

数据库对象。

created

String

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

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

updated

String

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

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

参数

参数类型

描述

type

String

数据库引擎，仅支持gaussdb-mysql。

version

String

数据库版本。数据库支持的详细版本信息，可通过查询数据库引擎的版本获取。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

创建参数模板，账户允许最大同时连接数为10。

POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations
{
  "name" : "myparameter",
  "description" : "parameter1",
  "datastore" : {
    "type" : "gaussdb-mysql",
    "version" : "8.0"
  },
  "parameter_values" : {
    "max_user_connections" : "10"
  }
}

响应示例

状态码： 200

Success.

{
  "configurations" : {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
    "name" : "myparameter",
    "description" : "parameter1",
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0"
    },
    "created" : "2022-05-15T11:53:34+0000",
    "updated" : "2022-05-15T11:53:34+0000"
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理