文档首页/ 云数据库 RDS/ API参考/ 历史API/ API v3/ 修改指定实例的参数
更新时间:2024-03-28 GMT+08:00
分享

修改指定实例的参数

功能介绍

修改指定实例的参数模板参数。

该接口计划于2025-03-31下线,建议及时切换到新接口修改指定实例的参数

调试

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

接口约束

  • 支持的数据库引擎:MySQL、PostgreSQL、Microsoft SQL Server。
  • 修改的参数必须在指定数据库版本的默认参数范围内,具体可配置范围请参见《云数据库 RDS用户指南》中“修改实例参数”的内容。
  • 敏感参数,例如:“lower_case_table_names”,修改存在风险,详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/configurations

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一region下的project ID。

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

    instance_id

    实例ID。

请求消息

参数说明
表2 参数说明

名称

是否必选

参数类型

说明

values

Map<String,String>

参数值对象,用户基于默认参数模板自定义的参数值。

  • key:参数名称,如“div_precision_increment”,“connect_timeout”。为空时不修改参数值。
  • value:参数值,如“6”,“20”。key不为空时value也不可为空。

请求示例

  • MySQL请求示例
    https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
    {
      "values" : { 
        "max_connections" : "10", 
        "autocommit" : "OFF",
        "binlog_checksum" : "CRC32",
        "innodb_purge_threads" : "4"
      } 
    }
  • PostgreSQL请求示例
    {
      "values" : { 
        "max_connections" : "10", 
        "autovacuum" : "on",
        "bytea_output" : "escape",
        "client_encoding" : "UTF8",
        "cpu_tuple_cost" : "0.01"
      } 
    }

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    任务ID。

    restart_required

    Boolean

    实例是否需要重启。

    • “true”需要重启。
    • “false”不需要重启。

    ignored_params

    List

    请求参数“values”中被忽略掉,没有生效的参数名称列表。

    当参数不存在时,参数修改不会下发,并通过此参数返回所有被忽略的参数名称。

  • 正常响应样例
    { 
      "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
      "restart_required" : "false",
      "ignored_params": []
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档