• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Parameter Configuration
  6. Modifying Parameters of a Specified DB Instance

Modifying Parameters of a Specified DB Instance

Function

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

URI

  • URI format

    PATH: /{version_id}/{project_id}/instances/{instance_id}/configurations

    Method: PUT

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    version_id

    Yes

    Specifies the API version. It is case-sensitive and the value is v3.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instance_id

    Yes

    Specifies the DB instance ID.

  • Restrictions
    • Currently, RDS supports the following DB engines and versions:
      • MySQL 5.6 and 5.7
      • PostgreSQL 9.5 and 9.6
      • Microsoft SQL Server 2014 SE, 2016 SE, and 2016 EE
    • The values of the edited parameters must be within the default value range of the specified database version. For details about the range of parameter values, see section "Editing Parameters in a Parameter Group" in the Relational Database Service User Guide.
    • Parameter group modifications will take effect for DB instances to which the parameter group applies. Some modifications take effect only after the DB instance reboots.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    values

    Yes

    Dictionary data structure

    Specifies the parameter group value defined by users based on the default parameter groups.

    For details, see Table 3.

    Table 3 values field data structure description

    Name

    Mandatory

    Type

    Description

    key

    Yes

    String

    Specifies the parameter name. For example, in "max_connections": "10", the key is max_connections.

    value

    Yes

    String

    Specifies the parameter value. For example, in "max_connections": "10", the value is 10.

  • Request example
{ 
    "values": { 
       "max_connections": "10", 
       "autocommit": "OFF" 
    }
}

Normal Response

  • Parameter description
    Table 4 Parameter description

    Name

    Type

    Description

    restart_required

    Boolean

    Indicates whether a reboot is required.

    • true: A reboot is required.
    • false: A reboot is not required.
  • Response example
{
  "restart_required": true
}

Abnormal Response

For details, see Abnormal Request Results.