Help Center/ GaussDB/ API Reference/ Historical APIs/ Parameter Configuration/ Obtaining the Parameters of a Specified DB Instance (v3)

Updated on 2025-08-11 GMT+08:00

View PDF

Obtaining the Parameters of a Specified DB Instance (v3)

Function

This API is used to obtain parameters of a specified DB instance. Before calling this API:

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

URI

GET /v3/{project_id}/instances/{instance_id}/configurations

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how 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. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

None

Response Parameters

**Table 2** Response parameters
Parameter	Type	Description
datastore_version	String	Definition Engine version. Range N/A
datastore_name	String	Definition Engine name. Range N/A
created	String	Definition Creation time in the yyyy-MM-dd HH:mm:ss format. for example, 2024-05-14 07:31:11. Range N/A
updated	String	Definition Update time in the yyyy-MM-ddHH:mm:ss format. for example, 2024-05-14 07:31:11. Range N/A
configuration_parameters	Array of objects	Definition Parameters defined by users based on the default parameter templates. For details, see Table 3.

**Table 3** configuration_parameters field data structure description
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 is modified. 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 string integer boolean list float
description	String	Definition Parameter description. Range N/A

Example Request

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/configurations
https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations

Example Response

{
    "created": "2022-04-11 10:46:59",
    "updated": "2022-04-11 10:46:59",
    "datastore_version": "2.0",
    "datastore_name": "GaussDB",
    "configuration_parameters": [
        {
            "name": "audit_system_object",
            "value": "12295",
            "type": "integer",
            "description": "Whether to audit the CREATE, DROP, and ALTER operations on database objects",
            "restart_required": false,
            "value_range": "0-2097151"
        }
    ]
}