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

Replicating the Parameter Template of a DB Instance

Function

This API is used to replicate the parameter template of a DB instance. Before calling this API:

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

URI

POST /v3/{project_id}/instances/{instance_id}/configurations/{configuration_id}/copy

**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
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
configuration_id	Yes	String	Definition Node ID. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with no07. 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
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Name of a parameter template generated after replication. Constraints N/A Range The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. Default Value N/A
description	No	String	Definition Description of a parameter template generated after replication. Constraints N/A Range The description can consist of up to 256 characters. It cannot contain carriage returns or any of the following special characters: !<"='>& Default Value It is left blank by default.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
configuration_id	String	Definition Parameter template ID. Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed.

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

Replicating the parameter template of a DB instance

POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/configurations/b26ab68e7a77495c8d84b92e4eaa33d3pr07/copy

{
  "name" : "paramTemplate-test-1",
  "description" : "test"
}

Example Response

Status code: 200

Success.

{
  "configuration_id" : "c82d8c54c4c7416a946f58d9ee89ed8epr07"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Parameter Template Management