• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. OpenStack trove API v1.0
  5. Parameter Configuration
  6. Obtaining Information About a Specified Parameter Group

Obtaining Information About a Specified Parameter Group

Function

This API is used to obtain information about a specified parameter group.

URI

  • URI format

    PATH: /{versionId}/{project_id}/configurations/{id}

    Method: GET

  • 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.

    When this parameter is empty (not space), the URL of the parameter group list is obtained. For details, see Obtaining a Parameter Group List.

  • Restrictions

    Currently, the DB engines MySQL and PostgreSQL support obtaining parameter groups.

Request

N/A

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    configuration

    List data structure. For details, see Table 3.

    Indicates the parameter group.

    Table 3 configuration field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the parameter group ID.

    name

    String

    Indicates the parameter group name.

    datastore_version_id

    String

    Indicates the database version ID.

    datastore_version_name

    String

    Indicates the database version name.

    datastore_name

    String

    Indicates the database name.

    description

    String

    Indicates the parameter group description.

    instance_count

    Int

    Indicates the number of associated DB instances.

    created

    String

    Indicates the parameter group creation time in the following format: yyyy-MM-dd THH:mm:ss.

    updated

    String

    Indicates the parameter group updated time in the following format: yyyy-MM-dd THH:mm:ss.

    values

    Dictionary data structure. For details, see Table 4.

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

    parameters

    List data structure. For details, see Table 5.

    Indicates the parameter list.

    Table 4 values field data structure description

    Name

    Type

    Description

    key

    String

    Indicates the parameter name. For example, in "xp_cmdshell": "0", the key is xp_cmdshell.

    value

    String

    Indicates the parameter value. For example, in "xp_cmdshell": "0", the value is 0.

    Table 5 parameters field data structure description

    Name

    Type

    Description

    name

    String

    Indicates the parameter name.

    value

    String

    Indicates the value.

    needRestart

    String

    Indicates whether the DB instance needs to be rebooted.

    • 0 indicates that the DB instance does not need to be rebooted.
    • 1 indicates that the DB instance needs to be rebooted.

    readonly

    String

    Indicates whether the parameter group is read-only.

    • 0 indicates that the parameter group is not read-only.
    • 1 indicates that the parameter group is read-only.

    valueRange

    String

    Indicates the value range, such as 0-1.

    datatype

    String

    Indicates the parameter type, which can be integer, string, boolean, list, or float.

    description

    String

    Indicates the parameter description.

  • Response example
    {
      "configuration": {
        "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
        "name": "default-mysql-5.6",
        "datastore_version_id": "",
        "datastore_version_name": "5.6",
        "datastore_name": "mysql",
        "description": "Default parameter group for mysql 5.6",
        "instance_count": 0,
        "created": "2017-05-05T04:40:51",
        "updated": "2017-05-05T04:40:51",
    "values": {
          "autocommit": "ON"
        },
        "parameters": [
          {
            "name": "auto_increment_increment",
            "value": "1",
            "needRestart": "0",
            "readonly": "1",
            "valueRange": "1-65535",
            "datatype": "integer",
            "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns."
          },
          {
            "name": "autocommit",
            "value": "ON",
            "needRestart": "0",
            "readonly": "1",
            "valueRange": "ON|OFF",
            "datatype": "boolean",
            "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. "
          }
        ]
      }
    }

Abnormal Response

For details, see Abnormal Request Results.