文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 参数配置/ 创建参数模板
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

创建参数模板

功能介绍

创建参数模板。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

name

是

String

参数模板名称，不可重复。 取值范围：长度1~64位之间，区分大小写字母，可包含字母、数字、中划线、下划线或句点，不能包含其他特殊字符。

description

否

String

参数模板描述，默认为空。 取值范围：长度超过256自动截取，不能包含回车>!<"&'=等特殊字符。

parameter_values

否

Map<String,String>

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

datastore

是

object

数据库引擎信息。可通过查询数据库引擎的版本接口查询。详情请参见表3。
表3 datastore参数说明

名称

是否必选

参数类型

说明

engine_version

是

String

数据库版本。

instance_mode

是

String

部署形态。

枚举值：

  • ha：主备版。
  • ha:readonly：主备版只读节点。
  • independent：分布式版独立部署。

响应参数

表4 参数说明

参数

参数类型

描述

id

String

参数模板ID。

name

String

参数模板名称。

created_at

String

创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

请求示例

  • 创建一个2.3版本，主备版部署形态的参数模板。 
    POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations
{
    "name": "paramTemplate",
    "description": "",
    "parameter_values": {
        "audit_system_object": "12294"
    },
    "datastore": {
        "engine_version": "2.3",
        "instance_mode": "ha"
    }
}
  • 创建一个2.3版本，分布式版独立部署形态，多个自定义参数的参数模板。 
    POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations
{
    "name": "paramTemplate",
    "description": "",
    "parameter_values": {
        "audit_system_object": "12294",
        "dn:effective_cache_size": "262143",
        "checkpoint_segments": "2048"
    },
    "datastore": {
        "engine_version": "2.3",
        "instance_mode": "independent"
    }
}

响应示例

创建参数模板成功。 
{ 
  "id" : "137eeaf0cc884ca4adffa9ebd101c115pr14", 
  "name" : "paramTemplate-del", 
  "created_at" : "2022-08-09T03:06:52+0800" 
}

状态码

错误码

请参见错误码。

父主题： 参数配置

相关文档