• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Parameter Configuration
  6. Obtaining the Parameter Group of a Specified DB Instance

Obtaining the Parameter Group of a Specified DB Instance

Function

This API is used to obtain the parameter group of a specified DB instance.

URI

  • URI format

    PATH: /{version_id}/{project_id}/instances/{instance_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.

    instance_id

    Yes

    Specifies the DB instance ID compliant with the UUID format.

  • 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

    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.

    configuration_parameters

    List data structure

    Indicates the parameter configuration defined by users based on the default parameter groups.

    For details, see Table 3.

    Table 3 configuration_parameters field data structure description

    Name

    Type

    Description

    name

    String

    Indicates the parameter name.

    value

    String

    Indicates the parameter value.

    restart_required

    Boolean

    Indicates whether a reboot is required.

    • false: A reboot is not required.
    • true: A reboot is required.

    readonly

    Boolean

    Indicates whether the parameter is read-only.

    • false: The parameter is not read-only.
    • true: The parameter is read-only.

    value_range

    String

    Indicates the parameter value range. For example, the value of integer is 0–1, and the value of boolean is true or false.

    type

    String

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

    description

    String

    Indicates the parameter description.

  • Response example
{
	"datastore_version_name": "5.7",
	"datastore_name": "mysql",
	"created": "2018-10-11 11:40:44",
	"updated": "2018-10-11 11:40:44",
	"configuration_parameters": [{
		"name": "auto_increment_increment",
		"value": "1",
		"restart_required": false,
		"readonly": false,
		"value_range": "1-65535",
		"type": "integer",
		"description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
	}]
}

Abnormal Response

For details, see Abnormal Request Results.