Help Center> Relational Database Service> API Reference> API v3.1 (Recommended)> Modifying Parameters of a Specified Instance
Updated on 2024-06-07 GMT+08:00

Modifying Parameters of a Specified Instance

Function

This API is used to modify parameters of a specified instance.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.

URI

  • URI format

    PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/configurations

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

Request

Table 2 Request body parameters

Name

Mandatory

Type

Description

values

Yes

Map<String,String>

Parameter values defined by users based on the default parameter template.

  • key: parameter name, for example, div_precision_increment or connect_timeout. If this parameter is not specified, no parameter value is to be changed.
  • value: parameter value, for example, 6 or 20. If key is not empty, the parameter value cannot be empty, either.

Example Request

  • Change parameter values of an RDS for MySQL instance.
    PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
    
    {
      "values" : { 
        "div_precision_increment": "6",
        "connect_timeout": "20",
        "binlog_checksum" : "CRC32",
        "innodb_purge_threads" : "4"
      } 
    }
  • Change parameter values of an RDS for PostgreSQL instance.
    {
      "values" : { 
        "autovacuum" : "on",
        "bytea_output" : "escape",
        "client_encoding" : "UTF8",
        "cpu_tuple_cost" : "0.01"
      } 
    }
  • Change parameter values of an RDS for SQL Server instance.
    {
       "values":{
         "max server memory (MB)":"26317",
         "max degree of parallelism":"4"
       }
    }

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Job ID.

    restart_required

    Boolean

    Whether a reboot is required.

    • true: A reboot is required.
    • false: A reboot is not required.
  • Example normal response
    { 
      "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
      "restart_required" : false
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.