Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Saving Instance Parameters As a Parameter Template
Updated on 2026-07-16 GMT+08:00
View PDF
Share

Saving Instance Parameters As a Parameter Template

Function

This API is used to save instance parameters as a parameter template. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/configurations/{config_id}/save

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the 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

config_id

Yes

String

Definition

ID of the parameter template to be saved. Obtain the parameter template ID of the instance by referring to Obtaining the Parameters of a Specified DB Instance.

Constraints

N/A

Range

The value can contain 36 characters. 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.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Name of the saved parameter template.

Constraints

The name must be unique.

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

Parameter template description.

Constraints

N/A

Range

The description can contain a maximum of 256 characters. Carriage return characters and the following special characters are not allowed: >!<"&'=

Default Value

The value is left blank by default.

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

config_id

String

Definition

ID of the saved parameter template.

Range

N/A

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/save
{ 
   "name" : "paramTemplate-1233", 
    "description": "Description"
}

Example Response

Parameter template saved.

{ 
  "config_id" : "3ca44134a16d4bbab8eb701e025b19f7pr14" 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration