# 创建参数模板 - CreatingaParameterTemplate #### 功能介绍 创建参数模板信息，包含参数模板名称、描述、数据库版本信息、参数值。 #### 接口约束 该接口支持如下数据库实例： - GeminiDB Cassandra - GeminiDB Mongo - GeminiDB Influx - GeminiDB Redis经典部署模式实例 创建参数模板名称"name"不能与默认参数模板或已有参数模板的名称重复。 values只能传入系统定义的，可修改的参数，其他情况则忽略不处理。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=CreateConfiguration)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:configuration:create | Write | - | - | nosql:param:create | - | #### URI POST /v3/{project_id}/configurations 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 参数模板名称。 **约束限制：** 最长64个字符，只允许大写字母、小写字母、数字、和"-_."特殊字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | description | 否 | String | **参数解释：** 参数模板描述。 **约束限制：** 最长256个字符，不支持\>!\<"\&'=特殊字符。 **取值范围：** 不涉及。 **默认取值：** 空。 | | values | 否 | Map\ | **参数解释：** 参数值对象，用户基于默认参数模板自定义的参数值。默认不修改参数值。 **约束限制：** 不涉及。 | | datastore | 否 | [ConfigurationDatastoreOption] object | **参数解释：** 数据库对象。 **约束限制：** 如果未传入instance_id参数，则该参数为必填项。 | | instance_id | 否 | String | **参数解释：** 实例ID，可以调用[7.3.3 查询实例列表和详情](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[7.3.1 创建实例](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 若传入此参数，则会基于此实例的参数信息创建参数模板。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4ConfigurationDatastoreOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 数据库类型。 **约束限制：** 不涉及。 **取值范围：** - GeminiDB Cassandra实例取值为"cassandra"。 - GeminiDB Mongo实例取值为"mongodb"。 - GeminiDB Influx实例取值为"influxdb"。 - GeminiDB Redis实例取值为"redis"。 **默认取值：** 不涉及。 | | version | 是 | String | **参数解释：** 数据库版本。 **约束限制：** 不涉及。 **取值范围：** - GeminiDB Cassandra实例支持3.11版本，取值为"3.11"。 - GeminiDB Mongo实例支持4.0版本，取值为"4.0"。 - GeminiDB Influx实例支持1.8版本，取值"1.8"。 - GeminiDB Redis实例支持5.0版本，取值"5.0"。 **默认取值：** 不涉及。 | | mode | 否 | String | **参数解释：** 数据库实例类型。 **约束限制：** 当创建支持GeminiDB Mongo、GeminiDB Influx 经典部署模式单节点、GeminiDB Influx经典部署模式集群增强版、GeminiDB Influx云原生部署模式、GeminiDB Cassandra云原生部署模式、GeminiDB Redis云原生部署模式实例的参数模板， 该参数必选。 **取值范围：** - GeminiDB Mongo副本集实例取值为"ReplicaSet"。 - GeminiDB Influx经典部署模式单节点实例取值为"InfluxdbSingle"。 - GeminiDB Influx经典部署模式集群增强版实例取值为"EnhancedCluster"。 - GeminiDB Influx云原生部署模式实例取值为"CloudNativeCluster"。 - GeminiDB Cassandra云原生部署模式实例取值为"CloudNativeCluster"。 - GeminiDB Redis云原生部署模式实例取值为"CloudNativeCluster"。 **默认取值：** 不传该参数，创建经典部署模式集群实例的参数模板。 | #### 响应参数 **状态码： 200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | configuration | [ConfigurationResult] object | **参数解释：** 参数模板信息。 | 表6ConfigurationResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | | mode | String | **参数解释：** 数据库实例类型。 **取值范围：** - GeminiDB Mongo副本集实例取值为"ReplicaSet"。 - GeminiDB Influx经典部署模式单节点实例取值为"InfluxdbSingle"。 - GeminiDB Influx经典部署模式集群增强版实例取值为"EnhancedCluster"。 - GeminiDB Influx云原生部署模式实例取值为"CloudNativeCluster"。 - GeminiDB Redis云原生部署模式实例取值为"CloudNativeCluster"。 - GeminiDB Cassandra云原生部署模式实例取值为"CloudNativeCluster"。 | #### 请求示例 - 创建Cassandra参数模板 ``` POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations { "name" : "configuration_test", "description" : "configuration_test", "values" : { "max_connections" : "10", "autocommit" : "OFF" }, "datastore" : { "type" : "cassandra", "version" : "3.11" } } ``` - 基于已有的实例id创建参数模版 ``` POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations { "name" : "myparameter_for_influxdb", "description" : "parameter1", "instance_id" : "9136fd2a9fcd405ea4674276ce36dae8in02" } ``` #### 响应示例 **状态码： 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" } } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。