GetInstanceFeatureGate - StarRocks集群实例的特性开关

更新时间:
复制 MD 格式

获取StarRocks集群实例的特性开关

接口说明

请确保在使用该接口前,已充分了解 Serverless StarRocks 产品的收费方式和计费项

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sr:GetInstanceFeatureGate

update

*Instance

acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

POST /webapi/features/featureGate HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

c-b25e21e24388****

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 请求状态码。

200

RequestId

string

请求 ID。

B67D142D-D54E-184F-A306-22BDC01B2XXX

Success

boolean

请求是否成功。

false

ErrCode

string

错误码。

InvalidParams

ErrMessage

string

错误信息。

Invalid params: [instance not exists].

Total

integer

实例总数。

100

Data

object

返回数据。

MountDlfMetaToken

boolean

支持挂载 DLF meta token

true

FullManagedSecurityGroup

boolean

托管安全组

true

SupportFastRestart

boolean

支持快速重启

true

SupportAddConfigTypes

array

新增的配置类型列表

string

新增的配置类型

lake_compaction_max_tasks

SupportCreateAgent

boolean

支持创建 Agent

true

SupportModifyTimezone

boolean

支持修改时区

true

SupportBackup

boolean

是否支持数据备份,取值说明:

  • 1:支持数据备份。

  • 2:不支持数据备份。

true

SupportMultiAZ

boolean

支持多 AZ 部署 Observer

true

SupportFastModeModifyResource

boolean

支持以快速重启的方式修改资源

true

SupportFastModeModifyConfig

boolean

支持在配置变更时快速重启

true

SupportCreateNonStandardNodeGroup

boolean

支持创建 standard 之外的规格类型计算组

true

UseComputeNode

boolean

使用 CN

true

SupportFeGateway

boolean

支持 FE 网关

true

ConsoleControlRestart

boolean

支持控制台来控制重启流程

true

EnableManageMv

boolean

支持管理物化视图

true

SupportEnableSSL

boolean

支持开启 SSL

true

SupportHostAlias

boolean

支持自定义域名

true

SupportEed

boolean

支持弹性临时盘

true

supportCompactionService

boolean

supportCompactionServiceWhiteList

boolean

是否支持 Compaction Service 白名单功能

true

SupportEnableAi

boolean

支持 AI Function

true

AccessDeniedDetail

string

AccessDeniedDetail

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "B67D142D-D54E-184F-A306-22BDC01B2XXX",
  "Success": false,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Total": 100,
  "Data": {
    "MountDlfMetaToken": true,
    "FullManagedSecurityGroup": true,
    "SupportFastRestart": true,
    "SupportAddConfigTypes": [
      "lake_compaction_max_tasks"
    ],
    "SupportCreateAgent": true,
    "SupportModifyTimezone": true,
    "SupportBackup": true,
    "SupportMultiAZ": true,
    "SupportFastModeModifyResource": true,
    "SupportFastModeModifyConfig": true,
    "SupportCreateNonStandardNodeGroup": true,
    "UseComputeNode": true,
    "SupportFeGateway": true,
    "ConsoleControlRestart": true,
    "EnableManageMv": true,
    "SupportEnableSSL": true,
    "SupportHostAlias": true,
    "SupportEed": true,
    "supportCompactionService": true,
    "supportCompactionServiceWhiteList": true,
    "SupportEnableAi": true
  },
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情