Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying the Parameter Setting Template for Scale-out Optimization

Updated on 2025-10-20 GMT+08:00

View PDF

Querying the Parameter Setting Template for Scale-out Optimization

Function

This API is used to query the parameter setting template for scale-out optimization. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/expansion-parameters

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	String	Yes	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

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 the request is processed, the value of X-Subject-Token in the message 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

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
expansion_parameters	Array of objects	Definition Parameter information. For details, see Table 4.

**Table 4** Parameter information
Parameter	Type	Description
name	String	Definition Parameter name. Range N/A
value	String	Definition Parameter value. Range N/A
restart_required	Boolean	Definition Whether a reboot is required after the parameter modification. Range true: A reboot is required. false: A reboot is not required.
value_range	String	Definition Parameter value range. Range N/A
type	String	Definition Parameter type. Range integer: integer boolean: Boolean string: character string
description	String	Definition Parameter description. Range N/A

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/expansion-parameters

Example Response

{
  "expansion_parameters": [
    {
      "name": "lockwait_timeout",
      "value": "",
      "restart_required": false,
      "value_range": "1-1200000",
      "type": "integer",
      "description": "Lock timeout interval for sessions, in milliseconds."
    }
  ]
}