Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Modifying Parameters in a Parameter Template
Updated on 2025-12-26 GMT+08:00
View PDF
Share

Modifying Parameters in a Parameter Template

Function

This API is used to modify parameters in a specified parameter template. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

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

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

values

Yes

Map<String,String>

Definition

Parameter values defined by users based on a default parameter template.

Example: For "failed_login_attempts": "4", failed_login_attempts indicates the parameter name, and 4 indicates the new parameter value.

Constraints

N/A

description

No

String

Definition

Parameter template description.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

job_id

String

Definition

ID of the job for modifying parameters of a specified instance.

Range

N/A

Example Request

Changing the value of failed_login_attempts to 4 
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/5c1d1e1cf9423369714e1b08ffd5f3f1pr14
{ 
    "values": { 
        "failed_login_attempts": "4"
    }
}

Example Response

{
  "job_id": "5a08604b-7820-4cf1-9356-b378c4fac694"
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration