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

创建参数模板

功能介绍

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

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

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

values只能传入系统定义的，可修改的参数，其他情况则忽略不处理。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

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

description

否

String

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

values

否

Map<String,String>

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

datastore

是

ConfigurationDatastoreOption object

数据库对象。
表4 ConfigurationDatastoreOption

参数

是否必选

参数类型

描述

type

是

String

数据库类型。

GeminiDB Cassandra实例取值为“cassandra”。

GeminiDB Mongo实例取值为"mongodb"。

GeminiDB Influx实例取值为"influxdb"。

version

是

String

数据库版本。

GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。

GeminiDB Mongo实例支持4.0版本，取值为"4.0"。

GeminiDB Influx实例支持1.7版本，取值"1.7"。

mode

否

String

数据库部署模式，GeminiDB Mongo该参数必选。

  • GeminiDB Mongo副本集实例取值为"ReplicaSet"。
  • GeminiDB Influx 单节点实例取值为"InfluxdbSingle"。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

configuration

ConfigurationResult object

参数模板信息。
表6 ConfigurationResult

参数

参数类型

描述

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。

请求示例

  • URI样例 
    POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations
  • 创建Cassandra参数模板 
    {
  "name" : "configuration_test",
  "description" : "configuration_test",
  "values" : {
    "max_connections" : "10",
    "autocommit" : "OFF"
  },
  "datastore" : {
    "type" : "cassandra",
    "version" : "3.11"
  }
}

响应示例

状态码： 200

Success

{
  "configuration" : {
    "id" : "463b4b58d0e84e2b95605dea4552fdpr06",
    "name" : "configuration_test",
    "datastore_version_name" : "3.11",
    "datastore_name" : "cassandra",
    "description" : "configuration_test",
    "created" : "2020-03-09T08:27:56+0800",
    "updated" : "2020-03-09T08:27:56+0800"
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理

相关文档