文档

CreateParameterGroup - 创建参数模板

更新时间:

创建PolarDB参数模板。

接口说明

参数模板可以批量管理集群的参数,您可以使用参数模板功能,快速应用模板到PolarDB集群上。详情请参见使用参数模板

说明 当前仅支持PolarDB MySQL版集群。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:CreateParameterGroupWrite
  • ParameterGroup
    acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

参数模板所在地域的地域ID。

说明 您可以通过接口DescribeRegions查看地域ID。
cn-hangzhou
DBTypestring

数据库引擎类型,当前仅支持MySQL

MySQL
DBVersionstring

数据库引擎版本号,取值范围如下:

  • 5.6

  • 5.7

  • 8.0

8.0
ParameterGroupNamestring

参数模板的名称,需满足如下要求:

  • 由英文、数字、和下划线()组成,以字母开头,不能包含中文,不能以下划线()结尾。

  • 长度为8~64个字符。

test_group
ParameterGroupDescstring

参数模板的描述,长度为0~199个字符。

test_group
Parametersstring

参数及其值的JSON串,参数的值都是字符串类型,例如{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}

说明 您可以通过接口DescribeParameterTemplates查看目标数据库引擎版本数据库集群的所有参数详情,包括参数名称、取值范围等。
{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}
ResourceGroupIdstring

资源组ID。

rg-**********

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

514D1D87-E243-4A5F-A87D-2785C3******
ParameterGroupIdstring

参数模板ID。

说明 您可以通过DescribeParameterGroups接口查看目标地域的参数模板列表,包括参数模板ID。
pcpg-**************

示例

正常返回示例

JSON格式

{
  "RequestId": "514D1D87-E243-4A5F-A87D-2785C3******",
  "ParameterGroupId": "pcpg-**************"
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegionId.Malformedhe specified parameter RegionId is not valid.-
400InvalidDBVersion.MalformedThe Specified DBVersion is not valid.指定的DBVersion无效
400InvalidParameterGroupName.MalformedThe Specified parameter ParameterGroupName is not valid.指定的参数ParameterGroupName无效
400NumberExceed.parameterGroupDescThe ParameterGroupDesc parameter`s number is exceed.ParameterGroupDesc参数的编号已超过
400InvalidEngine.UnsupportedThe specified Engine does not support this feature.指定的引擎不支持此功能
400ParamGroupsNameInvalidThe Specified parameter ParameterGroupName is not valid.指定的参数ParameterGroupName无效
404InvalidDBType.NotFoundThe Specified DBType does not found.找不到指定的DBType。
404InvalidUser.NotFoundSpecified user does not exist.指定的用户不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
  • 本页导读 (0)
文档反馈