• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  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: /{version_id}/{project_id}/configurations

    Method: GET

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

  • 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

Request

N/A

Normal Response

  • Parameter description
Table 2 Parameter description

Name

Type

Description

configurations

List data structure

Indicates the parameter group list.

For details, see Table 3.

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_name

String

Indicates the database version name.

datastore_name

String

Indicates the database name.

created

String

Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

updated

String

Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

user_defined

Boolean

Indicates whether the parameter group is created by users.

  • false: The parameter group is a default parameter group.
  • true: The parameter group is created by users.
  • Response example
{
	"configurations": [{
		"id": "b969f99ce0944137868d96a9fffeb7f5pr04",
		"name": "paramsGroup-b6d2",
		"description": "",
		"datastore_version_name": "2016_SE",
		"datastore_name": "sqlserver",
		"created": "2018-09-15T03:33:07+0800",
		"updated": "2018-09-15T03:33:07+0800",
		"user_defined": true
	}]
}

Abnormal Response

For details, see Abnormal Request Results.