Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Modifying Parameters of a Specified DB Instance
Updated on 2025-08-18 GMT+08:00
View PDF

Modifying Parameters of a Specified DB Instance

Function

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

Constraints

The values of the modified parameters must be within the default value range of the specified database version.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

Instance ID.

Request Parameters

Table 2 Parameter description

Name

Mandatory

Type

Description

values

Yes

Map<String,String>

Parameter values defined by users based on the default parameter templates.

Example: For failed_login_attempts: 4, failed_login_attempts indicates the parameter name, and 4 indicated the changed parameter value.

Response Parameters

Table 3 Parameter description

Name

Type

Description

restart_required

Boolean

Whether the instance needs to be rebooted.

  • true: indicates that the instance needs to be rebooted.
  • false: indicates that the instance does not need to be rebooted.

job_id

String

Task ID for modifying the parameters of a specified instance.

Example Request

  • Changing the value of failed_login_attempts to 4 (The change is applied without a DB instance reboot.) 
    PUT https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations
{ 
    "values": { 
        "failed_login_attempts": "4"
    }
}
  • Changing the value of track_activity_query_size to 2048 and the value of max_replication_slots to 25 (The changes are applied after the instance is rebooted.) 
    PUT https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations
{
    "values": {
        "track_activity_query_size": "2048",
        "max_replication_slots": "25"
    }
}

Example Response

  • Parameter modified (The instance does not need to be rebooted). 
    {
  "restart_required": false,
  "job_id": "5a08604b-7820-4cf1-9356-b378c4fac694"
}
  • Parameter modified (The instance needs to be rebooted). 
    {
  "restart_required": true,
  "job_id": "e51532df-b94d-4fbc-9cf0-aea030ade45d"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Parameter Configuration