Retrieves the feature gates for a StarRocks cluster instance.
Operation description
Before you call this operation, review the billing methods and billable items for Serverless StarRocks.
Try it now
Test
RAM authorization
Request syntax
POST /webapi/features/featureGate HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
c-b25e21e24388**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The request ID. |
B67D142D-D54E-184F-A306-22BDC01B2XXX |
| Success |
boolean |
Indicates whether the request was successful. |
false |
| ErrCode |
string |
The error code. |
InvalidParams |
| ErrMessage |
string |
The error message. |
Invalid params: [instance not exists]. |
| Total |
integer |
The total number of instances. |
100 |
| Data |
object |
The returned data. |
|
| MountDlfMetaToken |
boolean |
Indicates whether DLF meta tokens can be mounted. |
true |
| FullManagedSecurityGroup |
boolean |
managed security group |
true |
| SupportFastRestart |
boolean |
Indicates whether fast restart is supported. |
true |
| SupportAddConfigTypes |
array |
A list of new configuration types. |
|
|
string |
A new configuration type. |
lake_compaction_max_tasks |
|
| SupportCreateAgent |
boolean |
Indicates whether agents can be created. |
true |
| SupportModifyTimezone |
boolean |
Indicates whether the time zone can be modified. |
true |
| SupportBackup |
boolean |
Indicates whether data backup is supported.
|
true |
| SupportMultiAZ |
boolean |
Indicates whether observers can be deployed across multiple availability zones (AZs). |
true |
| SupportFastModeModifyResource |
boolean |
Indicates whether resources can be modified using fast restart. |
true |
| SupportFastModeModifyConfig |
boolean |
Indicates whether fast restart is supported for configuration changes. |
true |
| SupportCreateNonStandardNodeGroup |
boolean |
Indicates whether compute groups with specifications other than standard can be created. |
true |
| UseComputeNode |
boolean |
Indicates whether compute nodes (CNs) are used. |
true |
| SupportFeGateway |
boolean |
Indicates whether frontend (FE) gateways are supported. |
true |
| ConsoleControlRestart |
boolean |
Indicates whether the restart process can be controlled from the console. |
true |
| EnableManageMv |
boolean |
Indicates whether materialized views can be managed. |
true |
| SupportEnableSSL |
boolean |
Indicates whether SSL can be enabled. |
true |
| SupportHostAlias |
boolean |
Indicates whether custom domain names are supported. |
true |
| SupportEed |
boolean |
Indicates whether elastic ephemeral disks are supported. |
true |
| supportCompactionService |
boolean |
||
| SupportEnableAi |
boolean |
Indicates whether AI functions are supported. |
true |
| AccessDeniedDetail |
string |
The details of the access denial. |
{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" } |
Examples
Success response
JSON format
{
"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": false,
"SupportEnableAi": true
},
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxx\", \"EncodedDiagnosticMessage\": \"xxx\", \"AuthPrincipalType\": \"xxx\", \"AuthPrincipalDisplayName\": \"xxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"sr:xxx\" }"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.