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.
• Before calling this API, learn about request header parameters.

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 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
  config_id	Yes	Explanation: Parameter template ID. Constraints: N/A Value range: N/A Default value: N/A

Request

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 Parameters

  Parameter	Type	Description
  configuration_id	String	Explanation: Parameter template ID. Value range: N/A
  configuration_name	String	Explanation: Parameter template name. Value range: N/A
  success	Boolean	Explanation: Whether the parameter template is applied to all requested DB instances successfully. Value 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	Explanation: Task flow ID. Value range: N/A

• Example normal response

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

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.