文档

ModifyParameterGroup - 修改参数模板

更新时间:

该接口用于修改RDS参数模板。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

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

调试

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

授权信息

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

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

请求参数

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

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

rpg-13ppdh****
ParameterGroupNamestring

参数模板名称。

  • 以英文字母开头,由英文字母、数字、小数点(.)或下划线(_)组成。
  • 长度为 8~64 个字符。
说明 不传入该参数,则保持原参数模板名称。
testgroup1
ParameterGroupDescstring

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

说明 不传入该参数,则保持原参数模板描述。
test
Parametersstring

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

说明
  • 如果 ModifyMode 参数为 Individual,则传入该参数会覆盖原来的参数模板。
  • 如果 ModifyMode 参数为 Collectivity,则传入该参数会在原有参数模板的基础上进行新增或更改。
  • 不传入该参数,则保持原参数信息。
  • {"back_log":"3000"}
    RegionIdstring

    地域 ID。可以通过接口 DescribeRegions 查看地域 ID。

    说明 参数模板的地域不支持修改,您可以使用接口 CloneParameterGroup 复制参数模板到其他地域。
    cn-hangzhou
    ModifyModestring

    参数模板的修改模式。取值:

    • Collectivity(默认值):新增或变更。
    说明 Parameters 参数中传入的内容新增到当前参数模板,或变更当前参数模板中已有参数,当前参数模板中的其他参数不受影响。
    • Individual:覆盖。
    说明 将当前参数模板中的内容替换成 Parameters 参数中传入的内容。
    Collectivity
    ResourceGroupIdstring

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

    rg-acfmy****

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    ParameterGroupIdstring

    参数模板 ID。

    rpg-13ppdh****
    RequestIdstring

    请求 ID。

    857DC00B-7B85-4853-8B27-AD65EB618BC6

    示例

    正常返回示例

    JSON格式

    {
      "ParameterGroupId": "rpg-13ppdh****",
      "RequestId": "857DC00B-7B85-4853-8B27-AD65EB618BC6"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameters.MalformedThe specified parameter "Parameters" is not valid.-
    400ParamGroupsNotExistThis paramGroups not exist-
    400%sThe following parameters are prohibited: <br />%s-
    400ParamGroupsNameInvalidThe parameter group name is invalid.参数模板名称格式不正确,格式要求:以英文字母开头,由英文字母、数字、小数点(.)或下划线(_)组成,长度为8~64个字符。
    400InvalidParameterGroupId.MalformedSpecified parameterGroupId is not valid.参数模板ID无效(parameterGroupId),可以通过DescribeParameterGroups查看参数模板ID。
    400ParamGroupsNotExistOrTypeNotSupportThe parameter group does not exist or its type is not supported.参数模板不存在或参数模板类型不支持
    400ParamNotExistThis param Not Exist参数不存在,请检查 Parameters 参数配置。
    400ParamTypeErrorThe parameter type error.参数类型错误
    400ParamGroupsDescInvalidThe maximum length of parameter group description is exceeded.参数模板描述长度应为0~200个字符。
    400InvalidParameterValue.NotStandardInvalid parameter format.指定的参数格式不规范。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

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

    变更历史

    变更时间变更内容概要操作
    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
    • 本页导读 (1)
    文档反馈