• 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 a Parameter Group List

Obtaining a Parameter Group List

Function

This API is used to obtain a parameter group list, including all databases' default parameter groups and user-created parameter groups.

URI

  • URI format

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

    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.

  • Restrictions

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

Request

N/A

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    configurations

    List data structure. For details, see Table 3.

    Indicates the parameter group list.

    links

    List data structure. For details, see Table 4.

    Indicates the link compatible with OpenStack. Currently, this parameter functions as a placeholder.

    maxgrouplimit

    Int

    Indicates the maximum quota of user-created parameter groups. All DB engines share this quota. Its default value is 100.

    Table 3 configurations field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the parameter group ID.

    name

    String

    Indicates the parameter group name.

    description

    String

    Indicates the parameter group description.

    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.

    created

    String

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

    updated

    String

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

    allowed_updated

    Int

    Indicates whether the parameters in the obtained parameter group can be modified.

    • 0 indicates the parameters cannot be modified. When the default parameter group is obtained, this parameter value is 0.
    • 1 indicates the parameters can be modified.

    instance_count

    Int

    Indicates the number of associated DB instances.

    Table 4 links field data structure description

    Name

    Type

    Description

    href

    String

    Indicates the link address. Currently, this parameter functions as a placeholder and its value is "".

    rel

    String

    Indicates the link redirection. Currently, this parameter functions as a placeholder and its default value is next.

  • Response example
    { 
      "configurations": [
        {
          "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
          "name": "default-mysql-5.6",
          "description": "Default parameter group for mysql 5.6",
          "datastore_version_id": "",
          "datastore_version_name": "5.6",
          "datastore_name": "mysql",
          "created": "2017-01-01T10:00:00",
          "updated": "2017-01-01T10:00:00",
          "allowed_updated": 0,
          "instance_count": 0
    },
        {
          "id": "3bc1e9cc0d34404b9225ed7a58fb284epr01",
          "name": "test-mysql-5.6",
          "description": "test-mysql-5.6",
          "datastore_version_id": "",
          "datastore_version_name": "5.6",
          "datastore_name": "mysql",
          "created": "2017-02-01T10:00:00",
          "updated": "2017-02-01T10:00:00",
          "allowed_updated": 1,
          "instance_count": 2
        }
      ],
      "links": [
        {  
          "href": "",
          "rel": "next"
        }
      ],
      "maxgrouplimit": 100
    }

Abnormal Response

For details, see Abnormal Request Results.