更新时间:2025-07-29 GMT+08:00

创建参数模板

功能介绍

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

接口约束

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

URI

POST /v3/{project_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表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

参数解释

数据库版本,获取方法请参见查询数据库引擎的版本返回的name字段。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

configurations

ConfigurationSummary2 object

参数模板信息。

表6 ConfigurationSummary2

参数

参数类型

描述

id

String

参数解释

参数组ID。

取值范围

只能由英文字母、数字组成,前面为UUID,后缀为pr07,长度为36个字符。

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

参数解释

数据库版本,获取方法请参见查询数据库引擎的版本返回的name字段。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码: 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"
  }
}

状态码

请参见状态码

错误码

请参见错误码