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

Applying a Parameter Template

Function

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

Debugging

You can debug this API in API Explorer.

URI

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

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

Parameter template ID.

Obtain the parameter template ID by referring to Obtaining Parameter Templates.

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

instance_ids

Yes

Array of strings

Definition

Instance IDs. Obtain the IDs of the instances that the parameter template can be applied to by referring to Querying Instances That a Parameter Template Can Be Applied To.

Constraints

N/A

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

Definition

Asynchronous task ID for applying a parameter template.

Range

N/A

Example Request

Applying a parameter template

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/apply
{ 
   "instance_ids" : [ "5362449138da4e408dbae5152ca26640in14", "ea926816f0154066830d12ebebc8562din14" ] 
 }

Example Response

Parameter template applied.

{ 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Parameter Configuration