Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Enabling or Disabling Advanced Features
Updated on 2024-12-13 GMT+08:00
View PDF
Share

Enabling or Disabling Advanced Features

Function

This API is used to enable or disable advanced features. Before calling this API:

URI

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

Table 1 Parameter description

Name

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

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.

X-Language

No

String

Language.

Default value: en-us

Values:

  • zh-cn
  • en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

params

Yes

Object

Features to be modified. Its value is in JSON format and can be obtained from the response parameters in Querying Advanced Features. The key and value, respectively, correspond to name and range_description in the response parameters of the API for querying advanced features.

{

"key" : "value"

}

Response parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

Task ID.

Example Request

Enabling or disabling advanced feature 
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/e73893ef73754465a8bd2e0857bbf13ein14/advance-features
{
    "params": {
        "ledger": "on",
        "security": "on",
        "ilm": "on",
        "vectordb": "on"
    }
}

Example Response

{
  "job_id": "9cb66b27111669609799e022d08d6c3a"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management