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

Querying Advanced Features

Function

This API is used to query the advanced features of the current instance. Before calling this API:

Learn how to authenticate this API.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/advance-features

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	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	Instance ID.

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** Response body parameters
Parameter	Type	Description
features	Array of Table 4 FeatureResult	Advanced features.

**Table 4** FeatureResult
Parameter	Type	Description
name	String	Feature name.
status	String	Whether the feature is enabled. Value range: true false
description	String	Feature description.
type	String	Feature value type. Value range: integer string boolean
value	String	Feature value.
range	String	Feature value range.
range_description	String	Feature scope description.

Example Request

Querying the advanced features of the current instance and checking whether each feature is enabled

GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/e73893ef73754465a8bd2e0857bbf13ein14/advance-features

Example Response

{
    "features": [
        {
            "name": "ledger",
            "status": "off",
            "description" : "anti-proof database,"
            "type": "boolean",
            "range": "on|off",
            "value": "off",
            "range_description": "Whether to enable the ledger database function. The value on indicates the function is enabled, and the value off indicates that the function is disabled. If it is enabled, a new tamper-proof mode can be created and the common mode can be changed to the tamper-proof mode.
        },
        {
            "name": "ilm",
            "status": "off",
            ""description": " Advanced compression",
            "type": "boolean",
            "range": "on|off",
            "value": "off",
            "range_description": "Whether to enable OLTP table compression for data lifecycle management. The value on indicates that the function is enabled, and the value off indicates that the function is disabled."
        },
        {
            "name": "security",
            "status": "off",
            ""description": " Dynamic data masking",
            "type": "boolean",
            "range": "on|off",
            "value": "off",
            "range_description": "Set this parameter to on when a security policy is required. However, this occupies system resources and affects system performance."
        }
    ]
}

Status Code

Normal
200
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management