• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Parameter Configuration
  6. Modifying Parameter Group Parameters

Modifying Parameter Group Parameters

Function

This API is used to modify parameter group parameters, including the parameter name, description, and value, of a specified parameter group.

URI

  • URI format

    PATH: /{version_id}/{project_id}/configurations/{config_id}

    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.

    config_id

    Yes

    Specifies the parameter group 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 modified parameter group name must be different from the name of an existing or a default parameter group. Default parameter groups cannot be modified.
    • 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.
    • The parameter values to be changed cannot be left blank at the same time.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    name

    No

    String

    Specifies the parameter group name. It contains a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).

    description

    No

    String

    Specifies the parameter group description. It contains a maximum of 256 characters and does not support the following special characters: !<>='&" Its value is left blank by default.

    values

    No

    Dictionary data structure

    Specifies the parameter group value defined by users based on the default parameter groups. If this parameter is left blank, the parameter value cannot be changed.

    For details, see Table 3.

    Table 3 values field data structure description

    Name

    Mandatory

    Type

    Description

    key

    No

    String

    Specifies the parameter name. For example, in "max_connections": "10", the key is max_connections. If key is not empty, the parameter value cannot be empty, either.

    value

    No

    String

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

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

Normal Response

N/A

Abnormal Response

For details, see Abnormal Request Results.