Updated on 2023-10-18 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:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

configuration_id

Yes

String

Parameter template ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

instance_ids

Yes

Array of strings

Instance IDs. Up to 10 instance IDs can be returned.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID for applying a parameter template.

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.