首页 云数据库 RDS 开发参考 API参考 API目录 参数 CreateParameterGroup - 创建参数模板

CreateParameterGroup - 创建参数模板

更新时间: 2023-09-26 16:09:02

该接口用于创建RDS参数模板。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

调试

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

调试

授权信息

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

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

请求参数

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

创建参数模板的地域ID。可以通过接口DescribeRegions查看地域ID。

cn-hangzhou
ParameterGroupNamestring是

模板的名称。

  • 以英文字母开头，由英文字母、数字、小数点（.）或下划线（_）组成。
  • 长度为8~64个字符。
test1234
Enginestring是

数据库引擎，取值：

  • mysql
  • PostgreSQL
mysql
EngineVersionstring是

数据库版本，取值：

  • MySQL：
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL：
    • 10.0
    • 11.0
    • 12.0
    • 13.0
    • 14.0
    • 15.0
5.7
Parametersstring是

参数和值的JSON串，格式：{"参数1":"参数1值","参数2":"参数2值"......}。可修改的参数请参见设置MySQL实例参数或设置PostgreSQL实例参数。

{"back_log":"3000","wait_timeout":"86400"}
ParameterGroupDescstring否

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

test
ResourceGroupIdstring否

资源组ID。可调用DescribeDBInstanceAttribute获取。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

ParameterGroupIdstring

参数模板ID。可以通过接口DescribeParameterGroups查看参数模板ID。

rpg-q488w14xvsk****
RequestIdstring

请求ID。

7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1

示例

正常返回示例

JSON格式

{
  "ParameterGroupId": "rpg-q488w14xvsk****",
  "RequestId": "7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameters.MalformedThe specified parameter "Parameters" is not valid.当前Parameters参数无效，请重新设置。
400ParamGroupsNameInvalidThe specified parameter group name is invalid.参数模板名称格式不正确，格式要求：以英文字母开头，由英文字母、数字、小数点（.）或下划线（_）组成，长度为8~64个字符。
400InvalidEngine.MalformedSpecified engine is not valid.当前数据库引擎无效，请选择正确的数据库引擎。
400InvalidEngineVersion.MalformedSpecified engine version is not valid.数据库引擎版本无效，请确认后重试。
400ParamGroupsDbTypeNotSupportThe parameter group does not support the specified database type.参数模板当前仅支持MySQL实例。
400ParamGroupsDbVersionNotSupportThe parameter group does not support the database version.参数模板当前仅支持5.6、5.7、8.0版本的MySQL实例。
400ParamNotExistThis param Not Exist参数不存在，请检查 Parameters 参数配置。
400ParamTypeErrorThe parameter type error.参数类型错误
400ParamGroupsNotExistOrTypeNotSupportThe parameter group does not exist or its type is not supported.参数模板不存在或参数模板类型不支持
400InvalidRegion.FormatSpecified Region is not valid.指定的地域不合法，请检查该参数的正确性。
400%sThe following parameters are prohibited: <br />%s-
400ParamGroupsDescInvalidThe maximum length of parameter group description is exceeded.参数模板描述长度应为0~200个字符。
400InvalidParameterValue.NotStandardInvalid parameter format.指定的参数格式不规范。
400InvalidParameters.FormatSpecified parameter is not valid操作失败，指定的参数格式不合法。

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

变更历史

变更时间变更内容概要操作
2023-07-25OpenAPI 错误码发生变更，OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码：400
入参OpenAPI 入参发生变更
    新增入参：ResourceGroupId
2023-05-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-06-23OpenAPI 描述信息更新，OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码：400
阿里云首页 云数据库 RDS 相关技术圈