GetInstanceFeatureGate-阿里云帮助中心

Retrieves the feature gates for a StarRocks cluster instance.

Operation description

Before you call this operation, make sure that you understand the billing methods and billable items of Serverless StarRocks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sr:GetInstanceFeatureGate

update

*Instance

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

None

Request syntax

POST /webapi/features/featureGate HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	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	Whether DLF meta tokens can be mounted.	true
FullManagedSecurityGroup	boolean	Whether managed security groups are supported.	true
SupportFastRestart	boolean	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	Whether agents can be created.	true
SupportModifyTimezone	boolean	Whether the time zone can be modified.	true
SupportBackup	boolean	Whether data backup is supported. 1: Supports data backup. 2: Does not support data backup.	true
SupportMultiAZ	boolean	Whether observers can be deployed across multiple availability zones (AZs).	true
SupportFastModeModifyResource	boolean	Whether resources can be modified by using fast restart.	true
SupportFastModeModifyConfig	boolean	Whether fast restart is supported for configuration changes.	true
SupportCreateNonStandardNodeGroup	boolean	Whether compute groups with specifications other than `standard` can be created.	true
UseComputeNode	boolean	Whether the instance uses compute nodes (CNs).	true
SupportFeGateway	boolean	Whether the FE gateway is supported.	true
ConsoleControlRestart	boolean	Whether the restart process can be controlled from the console.	true
EnableManageMv	boolean	Whether materialized views can be managed.	true
SupportEnableSSL	boolean	Whether SSL can be enabled.	true
SupportHostAlias	boolean	Whether custom domain names are supported.	true
SupportEed	boolean	Whether elastic ephemeral disks are supported.	true
supportCompactionService	boolean
supportCompactionServiceWhiteList	boolean	Whether the Compaction Service allowlist feature is supported.	true
SupportEnableAi	boolean	Whether the AI function is 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,
    "supportCompactionServiceWhiteList": true,
    "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.