• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Parameter Configuration
  6. Applying a Parameter Group

Applying a Parameter Group

Function

This API is used to apply a parameter group to one or more DB instances.

URI

  • URI format

    PATH: /{version_id}/{project_id}/configurations/{config_id}/apply

    Method: PUT

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

    config_id

    Yes

    Indicates the parameter group ID.

  • Restrictions

    RDS supports the following DB engines:

    • MySQL 5.6 and 5.7
    • PostgreSQL 9.5 and 9.6
    • Microsoft SQL Server 2014 SE, 2016 SE, and 2016 EE

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    instance_ids

    Yes

    List data structure

    Specifies the DB instance ID list object.

  • Request example
{
	"instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"]
}

Normal Response

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Description

    configuration_id

    String

    Indicates the parameter group ID.

    configuration_name

    String

    Indicates the parameter group name.

    apply_results

    List data structure

    Indicates the parameter group application result.

    For details, see Table 4.

    success

    Boolean

    Indicates whether all parameter groups are applied to DB instances successfully.

    • true: Each parameter group is applied to DB instances successfully.
    • false: One or more parameter groups failed to be applied.
    Table 4 apply_results field data structure description

    Name

    Type

    Description

    instance_id

    String

    Indicates the DB instance ID.

    instance_name

    String

    Indicates the DB instance name.

    restart_required

    Boolean

    Indicates whether a reboot is required.

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

    success

    Boolean

    Indicates whether the parameter group application is successful.

    • true: The application is successful.
    • false: The application failed.
  • Response example
{
	"configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
	"configuration_name": "paramsGroup-bcf9",
	"apply_results": [{
		"instance_id": "fe5f5a07539c431181fc78220713aebein01",
		"instance_name": "zyy1",
		"restart_required": false,
		"success": false
	}, {
		"instance_id": "73ea2bf70c73497f89ee0ad4ee008aa2in01",
		"instance_name": "zyy2",
		"restart_required": false,
		"success": false
	}],
	"success": false
}

Abnormal Response

For details, see Abnormal Request Results.