Help Center/ GaussDB/ API Reference/ Historical APIs/ Parameter Configuration/ Modifying Parameters of a Specified DB Instance
Updated on 2024-08-20 GMT+08:00
View PDF
Share

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:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Modifying Parameters of a Specified DB Instance) before then.

Constraints

  • The values of the edited parameters must be within the default value range of the specified database version. For details about the range of parameter values, see "Modifying Parameters in a Parameter Template" in the GaussDB User Guide.

URI

PUT https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/configurations
Table 1 Parameter description

Parameter

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 Request parameters

Parameter

Mandatory

Type

Description

values

Yes

Map<String,String>

Parameter values defined by users based on a default parameter template For details, see Table 3.
Table 3 values field data structure description

Parameter

Mandatory

Type

Description

key

Yes

String

Parameter name. For example, for the "failed_login_attempts": "4" parameter, the key is failed_login_attempts.

value

Yes

String

Parameter value. For example, for the "failed_login_attempts": "4" parameter, the value is 4.

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

restart_required

Boolean

Whether a reboot is required.

  • true: A reboot is required.
  • false: A reboot is not required.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{ 
    "values": { 
       "xxx": "10", 
       "yyy": "OFF" 
    }
}

Example Response

{
  "restart_required": false
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Parameter Configuration