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

Querying Advanced Features

Function

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

URI

GET /v3/{project_id}/instances/{instance_id}/advance-features

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

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

instance_id

Yes

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 Response body parameters

Parameter

Type

Description

features

Array of Table 4 FeatureResult

Definition

Advanced features.

Table 4 FeatureResult

Parameter

Type

Description

name

String

Definition

Feature name.

Range

N/A

status

String

Definition

Whether the feature is enabled.

Range

  • true
  • false

description

String

Definition

Feature description.

Range

N/A

type

String

Definition

Feature value type.

Range

  • integer
  • string
  • boolean

value

String

Definition

Feature value.

Range

N/A

range

String

Definition

Feature value range.

Range

N/A

range_description

String

Definition

Feature scope description.

Range

N/A

Example Request

Querying the advanced features of the current instance and checking whether each feature is enabled
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/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

Error Codes

For details, see Error Codes.