Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Modifying Parameters for Scale-out Optimization
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Modifying Parameters for Scale-out Optimization

Function

This API is used to modify parameters for scale-out optimization. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

PUT /v3/{project_id}/instances/{instance_id}/expansion-parameters

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

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an 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.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

params

Yes

Object

Definition

Key-value pair of the parameter name and value.

Constraints

N/A

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

result

String

Definition

ID of the task for modifying scale-out optimization parameters.

Range

N/A

Example Request

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/expansion-parameters
{
    "params":
    {
        "failed_login_attempts": "4",
        "lockwait_timeout": "1"
    }
}

Example Response

{
	"result": "e96bbb23-e053-4bd0-b0b7-16ad3f5d9b6d"
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: Instance Management