Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Parameter Template Management/ Replicating the Parameter Template of a DB Instance
Updated on 2024-09-11 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:

URI

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

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.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

configuration_id

Yes

String

Parameter template ID.

To obtain the value, call the API for querying details of a DB instance.

After the request is processed, this parameter value is the value of configuration_id in the response body

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

Content-Type

Yes

String

Content type.

Value: application/json

X-Language

No

String

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

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

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the replicated parameter template.

The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed.

description

No

String

Description of the replicated parameter template. The value is left blank by default.

The description can consist of up to 256 characters, and cannot contain the carriage return characters or the following special characters: !<"='>&

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

configuration_id

String

Parameter template ID.

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

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.