• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. OpenStack trove API v1.0
  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: /{versionId}/{project_id}/configurations/{id}

    Method: PUT

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

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

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    id

    Yes

    Specifies the parameter group ID.

  • Restrictions
    • 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.
    • Currently, the DB engines MySQL and PostgreSQL support modifying parameter groups.
    • 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

    configuration

    Yes

    Dictionary data structure. For details, see Table 3.

    Specifies the parameter group.

    Table 3 configuration field data structure 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: !<>='&"

    values

    No

    Dictionary data structure. For details, see Table 4.

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

    Table 4 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.

    value

    No

    String

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

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

Normal Response

{
  "errCode": "RDS.0041",
  "externalMessage": "Operation accepted success."
}

Abnormal Response

For details, see Abnormal Request Results.