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

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.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the value, 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	String	Explanation: Instance ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None

Request Parameters

None

Response Parameters

**Table 2** Response parameters
Parameter	Type	Description
datastore_version	String	Explanation: Engine version. Value range: None
datastore_name	String	Explanation: Engine name. Value range: None
created	String	Explanation: Creation time in the "yyyy-MM-dd HH:mm:ss" format, for example, 2024-05-14 07:31:11. Value range: None
updated	String	Explanation: Update time in the "yyyy-MM-ddHH:mm:ss" format, for example, 2024-05-14 07:31:11. Value range: None
configuration_parameters	Array of objects	Explanation: 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	Explanation: Parameter name. Value range: None
value	String	Explanation: Parameter value. Value range: None
restart_required	Boolean	Explanation: Whether a reboot is required after the parameter is modified. Value range: true: A reboot is required. false: A reboot is not required.
value_range	String	Explanation: Parameter value range. Value range: None
type	String	Explanation: Parameter type. Value range: string integer boolean list float
description	String	Explanation: Parameter description. Value range: None

Example Request

https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/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"
        }
    ]
}

Status Code

Normal
200
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Parameter Configuration