Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Parameter Template Management/ Replicating a Parameter Template
Updated on 2025-07-11 GMT+08:00
View PDF

Replicating a Parameter Template

Function

This API is used to replicate a parameter template. Before calling this API:

URI

POST /v3/{project_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 can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

configuration_id

Yes

String

Definition:

ID of a custom parameter template.

Constraints:

N/A

Range:

To obtain this value, see Querying Parameter Templates.

After the request is processed, the value of id in the response body is the value of configuration_id. Enter the ID of the configuration whose user_defined is set to true.

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 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:

Empty

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

configuration_id

String

Definition:

Parameter template ID.

Range:

The value can contain 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 a parameter template

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/a2069d40256f40078c52d90d6a91ee63pr07/copy

{
  "name" : "paramTemplate-new",
  "description" : "new-parameter-group"
}

Example Response

Status code: 200

Success.

{
  "configuration_id" : "7b4e07852bd54016906e89461b3182cdpr02"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.