Obtaining the Parameters of a Specified DB Instance

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.2/{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. 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. 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
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. Range N/A
updated	String	Definition Update time in the yyyy-MM-ddHH:mm:ss format. Range N/A
configuration_parameters	Array of objects	Definition Parameters defined by users based on the default parameter templates. For details, see Table 4.

**Table 4** 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 N/A
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

Obtaining parameters of a specified DB instance

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.2/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations

Example Response

Parameters of the instance queried.

{
    "created": "2022-04-11 10:46:59",
    "updated": "2022-04-11 10:46:59",
    "datastore_version": "V2.0-2.0",
    "datastore_name": "GaussDB",
    "configuration_parameters": [
        {
            "name": "audit_system_object",
            "value": "12295",
            "type": "integer",
            "description": "Determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include databases, users, schemas, and tables. You can change the parameter value to audit only the operations on required database objects. During a forcible primary/standby failover, set audit_system_object to the maximum value and audit all DDL objects. If the parameter value is incorrectly changed, DDL audit logs will be lost. Contact customer service personnel to change it.",
            "restart_required": false,
            "value_range": "0-2097151"
        }
    ]
}