Updated on 2026-03-16 GMT+08:00

Applying a Parameter Template

Function

This API is used to apply a parameter template to a specified DB instance. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/configurations/{configuration_id}/apply

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
configuration_id	Yes	String	Definition Parameter template ID. To obtain this value, see Querying Parameter Templates. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
instance_ids	Yes	Array of strings	Definition List of instance IDs. Constraints The list contains a maximum of 10 instance IDs.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition ID of the task for applying a parameter template. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Applying a parameter template

PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr07/apply
{
  "instance_ids" : ["1c3f12d626824d4ca357104def25a455in07"]
}

Example Response

Status code: 200

Success.

{
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Parameter Template Management