API overview
Updated at:
API standards and multilingual preset SDKs
The OpenAPI of this product (starrocks/2022-10-19) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Gateway management
|
API |
Title |
Description |
| UpdateGateway | UpdateGateway | Updates the number of gateway nodes. |
| ListGateway | ListGateway | Lists gateways. |
| DeleteGateway | DeleteGateway | Deleting a gateway |
| AddGateway | AddGateway | Creates a gateway. |
Instance management
|
API |
Title |
Description |
| CreateInstanceV1 | Create an instance | Creates a Serverless StarRocks instance. |
| RestartInstance | RestartInstance | Restarts an E-MapReduce (EMR) Serverless StarRocks instance. |
| ReleaseInstance | ReleaseInstance | Releases a pay-as-you-go E-MapReduce (EMR) Serverless StarRocks instance. To unsubscribe from a subscription instance, go to the Unsubscribe page of the Expenses and Costs console. |
| UpdateInstanceName | UpdateInstanceName | Modifies the name of an E-MapReduce (EMR) Serverless StarRocks instance. |
| DescribeInstances | Query instances | Queries Serverless StarRocks instances. You can filter instances by instance name, tags, and other criteria. |
| DescribeNodeGroups | Query compute groups | Retrieves node group information. |
| TagResources | TagResources | Attaches tags to specified resources. |
| UnTagResources | UnTagResources | Detaches tags from multiple resources. |
| ChangeResourceGroup | ChangeResourceGroup | This operation changes the resource group of a Serverless StarRocks instance. |
Version management
|
API |
Title |
Description |
| UpgradeVersion | Upgrade version | Upgrades the version of a Serverless StarRocks instance. Serverless StarRocks has two levels of version definition: the major version displayed in the "Version" field on the cluster details page, and the minor version displayed in the "Minor Version" field on the cluster details page. This operation can be used to upgrade either the minor version or the major version. You can call the QueryUpgradableVersions operation to query the versions to which a cluster can be upgraded. |
| QueryUpgradableVersions | QueryUpgradableVersions | Queries the available upgrade versions for an EMR Serverless StarRocks instance. StarRocks instances have two version layers: a major version and a minor version. You can view both versions in the Version Information section on the Instance Details page in the EMR console. Use the Minor parameter to specify whether to query upgradable minor versions or major versions. |
Resource specification change
|
API |
Title |
Description |
| ModifyNodeNumberPreCheck | ModifyNodeNumberPreCheck | Performs a precheck before you modify the number of nodes in a warehouse of an E-MapReduce (EMR) Serverless StarRocks instance. |
| ModifyNodeNumber | Modify node count | Modifies the number of nodes in a compute group of a Serverless StarRocks instance. |
| ModifyCuPreCheck | Pre-check before modifying compute group node cUs | Performs a dry run to check whether the number of CUs can be scaled up or down for nodes in the FE, BE, or CN compute group of a Serverless StarRocks instance. |
| ModifyDiskPerformanceLevel | Modify disk performance level | Modifies the disk performance level (PL) of nodes in a compute group of a Serverless StarRocks instance. |
| ModifyDiskSize | Scale up disk capacity | Scales up the disk capacity of compute group nodes in a Serverless StarRocks instance. |
| ModifyDiskNumber | Increase disk count | Increases the number of disk blocks for a compute group node in a Serverless StarRocks instance. |
| ModifyCu | Modify CU quantity | Modifies the number of CUs for nodes in a compute group of a Serverless StarRocks instance. |
Configuration management
|
API |
Title |
Description |
| DescribeInstanceConfigs | DescribeInstanceConfigs | Queries instance configurations. |
| DescribeConfigHistory | Query configuration modification history | Querying instance configuration history |
| ModifyInstanceConfig | ModifyInstanceConfig | This API modifies the configuration of a Serverless StarRocks instance. |
| ModifyInstanceConfigPreCheck | Precheck before modifying instance configuration | This operation pre-checks modifications to the instance configuration of a Serverless StarRocks instance. |
| RollbackConfigModification | RollbackConfigModification | Rolls back a configuration modification that is currently in progress. |
Other
|
API |
Title |
Description |
| CreateServiceLinkedRole | CreateServiceLinkedRole | This operation creates the AliyunServiceRoleForEMRStarRocks role. |
| DeleteBackup | DeleteBackup | Deletes a data backup. |
| DeleteInnerIpWhitelistGroup | DeleteInnerIpWhitelistGroup | Deletes an internal network whitelist group. |
| DescribeRegions | DescribeRegions | You can view the list of available regions. |
| DescribeSystemTimezone | DescribeSystemTimezone | Obtain the system time zone of a StarRocks instance |
| EnableInternalSlb | EnableInternalSlb | Enables the internal Server Load Balancer (SLB) for the default gateway of an EMR Serverless StarRocks instance. |
| IsolateLeader | IsolateLeader | Enable read/write splitting. The Leader FE node handles write requests, and other nodes handle read requests. |
| ModifyUserPassword | ModifyUserPassword | Modifies the password for a StarRocks user. |
| QueryUnpaidOrder | QueryUnpaidOrder | Queries the unpaid orders of a compute group or cluster. |
| RestartNodeGroup | RestartNodeGroup | Restarts a specified node group. |
| RestartNodes | RestartNodes | Restart nodes in a cluster. |
| RestoreInstance | RestoreInstance | Restore an instance from a backup |
| ResumeInstance | ResumeInstance | Resumes an instance automatically stopped by openlake. |
| SwitchActiveStandbyZones | SwitchActiveStandbyZones | Switches the active and standby zones. |
| ToggleAutoMinorVersionUpgrade | ToggleAutoMinorVersionUpgrade | Enables or disables automatic minor version upgrades for a StarRocks instance. |
| TogglePublicSlb | TogglePublicSlb | Switches an Internet-facing SLB instance on or off. |
| UpdateBackup | UpdateBackup | Updates the description of a backup job. |
| AddBackupPolicy | AddBackupPolicy | Adds a backup policy. |
| CheckInventory | CheckInventory | Check the inventory of resources. |
| CreateAgentResource | CreateAgentResource | Creates an Agent compute group. |
| CreateScalingRule | CreateScalingRule | Create a scaling rule. |
| DeleteBackupPolicy | DeleteBackupPolicy | Deletes a backup policy. |
| DeleteScalingRule | DeleteScalingRule | Deletes a scaling rule. |
| DescribeAvailableZones | DescribeAvailableZones | Queries the available zones in a region. |
| DescribeBackupPolicies | DescribeBackupPolicies | Retrieve details of backup policies. |
| DescribeBackups | DescribeBackups | Obtain backup details |
| DescribeEventNames | DescribeEventNames | Retrieve the cluster event name. |
| DescribeInnerIpWhitelistGroups | DescribeInnerIpWhitelistGroups | Describes the whitelist groups for a private network. |
| DescribeInstanceDiagnosisResult | DescribeInstanceDiagnosisResult | Retrieve instance health diagnosis results. |
| DescribeInstanceMetaToken | DescribeInstanceMetaToken | Obtains the meta token for a StarRocks instance. |
| DescribeResourceConstraints | DescribeResourceConstraints | Get resource constraint configurations. |
| DescribeTimeTriggerScalingRules | DescribeTimeTriggerScalingRules | Retrieves the details of time-triggered scaling rules. |
| DisableSSLConnection | DisableSSLConnection | Disables SSL for a StarRocks connection. |
| EnableMultiAz | EnableMultiAz | Enables Multi-AZ deployment. |
| EnableSSLConnection | EnableSSLConnection | Enables SSL for a StarRocks connection. |
| GetInstanceFeatureGate | GetInstanceFeatureGate | Retrieves the feature gates for a StarRocks cluster instance. |
| GetNodeGroupFeatureGate | GetNodeGroupFeatureGate | Retrieve the feature gate for a StarRocks compute group instance. |
| ListOperationActivity | Query operation details | Retrieves the details of an operation. |
| ListOperationHistory | ListOperationHistory | Retrieves the operation history of a cluster. |
| ListSSLDetails | ListSSLDetails | Retrieves the ssl certificate details for a cluster. |
| ModifyChargeType | ModifyChargeType | Change the billing method for an instance |
| ModifyDiskType | Modify the disk type of nodes in a compute group | Modifies the disk type of nodes in a compute group. |
| ModifyHostAlias | ModifyHostAlias | Modifies the /etc/hosts file. |
| ModifyMaintainableTime | ModifyMaintainableTime | Modifies the maintenance window for a StarRocks instance. |
| ModifyScalingRule | ModifyScalingRule | Modifies an Auto Scaling rule. |
| ModifySpecType | Modify the node specifications type of a compute group | Modifies the node specifications type of a compute group. |
| ModifySpecTypePreCheck | ModifySpecTypePreCheck | Runs a precheck to modify the node specification type for a compute group. |
| QueryEnableMultiAzPrice | QueryEnableMultiAzPrice | Queries the price for enabling multi-zone deployment. |
| QueryMinorVersion | QueryMinorVersion | Queries the latest minor version for the current major version. |
| QueryModifyChargeTypePrice | QueryModifyChargeTypePrice | Queries the price for changing the billing method of a StarRocks instance. |
| QueryModifyCuPrice | Query price for modifying compute group node CU | Queries the price for modifying the CU count of a compute group node. |
| QueryModifyDiskNumberPrice | QueryModifyDiskNumberPrice | Retrieve the price for changing the number of disks in a compute group node |
| QueryModifyDiskPerformanceLevelPrice | QueryModifyDiskPerformanceLevelPrice | Queries the price of changing the disk performance level for a compute group node. |
| QueryModifyDiskSizePrice | QueryModifyDiskSizePrice | Queries the price for modifying the disk size of a single node in a compute group. |
| QueryModifyDiskTypePrice | QueryModifyDiskTypePrice | Queries the price for modifying the disk type of nodes in a compute group. |
| QueryModifyNodeNumberPrice | QueryModifyNodeNumberPrice | Queries the price for changing the number of nodes in a compute group. |
| QueryModifySpecTypePrice | QueryModifySpecTypePrice | Queries the price to change the specification type of a compute group. |
| QueryPriceV1 | QueryPriceV1 | An API for querying the price of new StarRocks purchases. |
| QueryRefundPrice | QueryRefundPrice | Pricing information for unsubscribing from StarRocks subscription instances |
| QueryRenewPrice | QueryRenewPrice | Query the renewal price for a StarRocks billing instance. |
| RebootECS | RebootECS | Reboot ECS instances in a cluster. |
| RenewInstance | RenewInstance | Renews an instance. |
| UpdateBackupPolicy | UpdateBackupPolicy | Updates a backup policy. |
| UpdateInnerIpWhitelistGroup | UpdateInnerIpWhitelistGroup | Updates the CIDR blocks in a whitelist group. |
| UpdateNodeGroupDescription | UpdateNodeGroupDescription | Updates the description of a compute group. |
| UpdatePublicNetworkStatus | UpdatePublicNetworkStatus | Enable or disable the Internet-facing SLB for the FE or BE component. |
Is this page helpful?