Applying a Parameter Template

Function

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

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

URI

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

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
config_id	Yes	Definition Parameter template ID. Constraints N/A Range N/A Default Value N/A

Request

Parameter description

**Table 2** Parameters
Parameter	Mandatory	Type	Description
instance_ids	Yes	Array of strings	Definition Instance IDs. Constraints N/A Range N/A Default Value N/A

Example Request

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

Response

Normal response

**Table 3** Parameters
Parameter	Type	Description
configuration_id	String	Definition Parameter template ID. Range N/A
configuration_name	String	Definition Parameter template name. Range N/A
apply_results	Array of objects	Definition Result of applying the parameter template. For details, see Table 4.
success	Boolean	Definition Whether the parameter template is applied to all requested DB instances successfully. Range 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	Definition Task ID. Range N/A

**Table 4** apply_results field data structure description
Parameter	Type	Description
instance_id	String	Definition Instance ID. Range N/A
instance_name	String	Definition Instance name. Range N/A
restart_required	Boolean	Definition Whether a reboot is required. Range true: A reboot is required. false: A reboot is not required.
success	Boolean	Definition Whether the parameter template is applied to the DB instance successfully. Range true: The application was successful. false: The application failed.

Example normal response

{
	"configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
	"configuration_name": "paramsGroup-bcf9",
        "job_id":"e4942c94-9d66-458e-beb7-90601664641e",
	"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
}