文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 查询高级特性
更新时间：2024-12-13 GMT+08:00
查看PDF
分享

查询高级特性

功能介绍

查询当前实例高级特性列表。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

语言。

缺省值：en-us

枚举值：

  • zh-cn
  • en-us

响应参数

表3 响应Body参数

参数

参数类型

描述

features

Array of 表4 FeatureResult

高级特性列表。
表4 FeatureResult

参数

参数类型

描述

name

String

特性名称。

status

String

特性是否开启。

枚举值：

  • true
  • false

description

String

特性中文描述。

type

String

特性值类型。

枚举值：

  • integer
  • string
  • boolean

value

String

特性值。

range

String

特性值范围。

range_description

String

特性范围描述。

请求示例

查询当前实例的高级特性列表，以及每个特性是否开启。 
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/e73893ef73754465a8bd2e0857bbf13ein14/advance-features

响应示例

{
    "features": [
        {
            "name": "ledger",
            "status": "off",
            "description": "防篡改",
            "type": "boolean",
            "range": "on|off",
            "value": "off",
            "range_description": "是否启用账本数据库功能。若此参数设置为打开（on）状态，则启用账本数据库功能，允许创建新的防篡改模式和修改普通模式为防篡改模式。on表示开启，off表示关闭。"
        },
        {
            "name": "ilm",
            "status": "off",
            "description": "高级压缩",
            "type": "boolean",
            "range": "on|off",
            "value": "off",
            "range_description": "是否开启数据生命周期管理-OLTP表压缩特性。on表示开启，off表示关闭。"
        },
        {
            "name": "security",
            "status": "off",
            "description": "动态数据脱敏",
            "type": "boolean",
            "range": "on|off",
            "value": "off",
            "range_description": "需要使用安全策略时设置为on，会占用系统资源，对系统性能产生影响。"
        }
    ]
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档