Applying a Parameter Template

Function

This API is used to apply a parameter template to one or more DB instances. This task will be executed asynchronously. You can query the execution status and result of applying a parameter template to DB instances based on job_id in the returned result. For details, see Obtaining Information About a Task with a Specified ID.

Before calling an API, you need to understand the API in Authentication.

Constraints

The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.

URI

URI format
PUT /v3.1/{project_id}/configurations/{config_id}/apply

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
config_id	Yes	Specifies the parameter template ID.

Request

**Table 2** Parameter description
Name	Mandatory	Type	Description
instance_ids	Yes	Array of strings	Specifies the DB instance ID list object.

Example Request

Apply a parameter template to multiple DB instances.

PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply

{
	"instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"]
}

Response

Normal response

**Table 3** Parameter description
Name	Type	Description
configuration_id	String	Parameter template ID.
configuration_name	String	Parameter template name.
success	Boolean	Whether the parameter template is applied to all requested DB instances successfully. true: The parameter template was successfully applied to all requested DB instances. false: The parameter template failed to be applied to one or more requested DB instances.
job_id	String	Task ID.

Example normal response

{
	"configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
	"configuration_name": "paramsGroup-bcf9",
        "job_id":"e4942c94-9d66-458e-beb7-90601664641e",
        "success":true
}