API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (starrocks/2022-10-19) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
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 | CreateInstanceV1 | Creates a Serverless StarRocks instance. |
| DescribeInstances | DescribeInstances | This operation queries Serverless StarRocks instances. You can filter the instances by criteria such as instance name and tags. |
| DescribeNodeGroups | DescribeNodeGroups | Retrieves information about node groups. |
| 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 | UpgradeVersion | This API upgrades the version of a Serverless StarRocks instance. Serverless StarRocks defines two version layers: a major version and a minor version. The major version is displayed in the Version field on the cluster product page. The minor version is displayed in the Minor Version field on the cluster product page. You can use this API to perform a minor version update or a major engine version upgrade. You can call the QueryUpgradableVersions API to query the available upgrade versions for the cluster. |
Resource allocation
|
API |
Title |
Description |
| ModifyNodeNumber | ModifyNodeNumber | Modifies the number of nodes in a compute group of a Serverless StarRocks instance. |
| ModifyDiskPerformanceLevel | ModifyDiskPerformanceLevel | This operation modifies the disk performance level of the nodes in a compute group of a Serverless StarRocks instance. |
| ModifyDiskSize | ModifyDiskSize | Scales out the disk of a compute group node for a Serverless StarRocks instance. |
| ModifyDiskNumber | ModifyDiskNumber | Increases the number of disks for the nodes in a compute group of a Serverless StarRocks instance. |
| ModifyCu | ModifyCu | You can use this API to change the number of Compute Units (CUs) in a compute group of a Serverless StarRocks instance. |
Configuration Management
|
API |
Title |
Description |
| ModifyInstanceConfig | ModifyInstanceConfig | This API modifies the configuration of a Serverless StarRocks instance. |
Other
|
API |
Title |
Description |
| CreateServiceLinkedRole | CreateServiceLinkedRole | This operation creates the AliyunServiceRoleForEMRStarRocks role. |
| IsolateLeader | IsolateLeader | Enable read/write splitting. The Leader FE node handles write requests, and other nodes handle read requests. |
| 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. |
| TogglePublicSlb | TogglePublicSlb | Switches an Internet-facing SLB instance on or off. |
| DisableSSLConnection | DisableSSLConnection | Disables SSL for a StarRocks connection. |
| EnableSSLConnection | EnableSSLConnection | Enables SSL for a StarRocks connection. |
| GetInstanceFeatureGate | GetInstanceFeatureGate | Retrieves the feature gates for a StarRocks cluster instance. |
| ModifyChargeType | ModifyChargeType | Change the billing method for an instance |
| ModifyDiskType | ModifyDiskType | Change the disk type for nodes in a compute group |
Others
|
API |
Title |
Description |
| 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. |
| DeleteBackup | DeleteBackup | Deletes a data backup. |
| DeleteBackupPolicy | DeleteBackupPolicy | Deletes a backup policy. |
| DeleteInnerIpWhitelistGroup | DeleteInnerIpWhitelistGroup | Deletes an internal network whitelist group. |
| 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 |
| DescribeConfigHistory | Query configuration modification history | Querying instance configuration history |
| DescribeEventNames | DescribeEventNames | Retrieve the cluster event name. |
| DescribeInnerIpWhitelistGroups | DescribeInnerIpWhitelistGroups | Describes the whitelist groups for a private network. |
| DescribeInstanceConfigs | DescribeInstanceConfigs | Queries instance configurations. |
| DescribeInstanceDiagnosisResult | DescribeInstanceDiagnosisResult | Retrieve instance health diagnosis results. |
| DescribeInstanceMetaToken | DescribeInstanceMetaToken | Obtains the meta token for a StarRocks instance. |
| DescribeRegions | DescribeRegions | You can view the list of available regions. |
| DescribeResourceConstraints | DescribeResourceConstraints | Get resource constraint configurations. |
| DescribeSystemTimezone | DescribeSystemTimezone | Obtain the system time zone of a StarRocks instance |
| DescribeTimeTriggerScalingRules | DescribeTimeTriggerScalingRules | Retrieves the details of time-triggered scaling rules. |
| EnableInternalSlb | EnableInternalSlb | Enables the internal Server Load Balancer (SLB) for the default gateway of an EMR Serverless StarRocks instance. |
| EnableMultiAz | EnableMultiAz | Enables Multi-AZ deployment. |
| GetNodeGroupFeatureGate | GetNodeGroupFeatureGate | Retrieve the feature gate for a StarRocks compute group instance. |
| ListOperationActivity | ListOperationActivity | Gets detailed information about activities for a specified operation. |
| ListOperationHistory | ListOperationHistory | Retrieves the operation history of a cluster. |
| ModifyCuPreCheck | ModifyCuPreCheck | Performs a precheck before you modify the number of CUs for a warehouse. |
| ModifyHostAlias | ModifyHostAlias | Modifies the /etc/hosts file. |
| ModifyInstanceConfigPreCheck | Precheck before modifying instance configuration | This operation pre-checks modifications to the instance configuration of a Serverless StarRocks instance. |
| ModifyMaintainableTime | ModifyMaintainableTime | Modifies the maintenance window for a StarRocks instance. |
| ModifyNodeNumberPreCheck | ModifyNodeNumberPreCheck | Performs a precheck before you modify the number of nodes in a warehouse of an E-MapReduce (EMR) Serverless StarRocks instance. |
| ModifyScalingRule | ModifyScalingRule | Modifies an Auto Scaling rule. |
| ModifySpecType | ModifySpecType | Modify the node specifications type of the compute group. |
| ModifySpecTypePreCheck | ModifySpecTypePreCheck | Runs a precheck to modify the node specification type for a compute group. |
| ModifyUserPassword | ModifyUserPassword | Modifies the password for a StarRocks user. |
| 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 | QueryModifyCuPrice | Queries the price for modifying the CU of compute group nodes. |
| 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. |
| QueryUnpaidOrder | QueryUnpaidOrder | Queries the unpaid orders of a compute group or cluster. |
| 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. |
| RebootECS | RebootECS | Reboot ECS instances in a cluster. |
| 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. |
| RenewInstance | RenewInstance | Renews an instance. |
| RestartInstance | RestartInstance | Restarts an E-MapReduce (EMR) Serverless StarRocks instance. |
| RollbackConfigModification | RollbackConfigModification | Rolls back a configuration modification that is currently in progress. |
| SwitchActiveStandbyZones | SwitchActiveStandbyZones | Switches the active and standby zones. |
| ToggleAutoMinorVersionUpgrade | ToggleAutoMinorVersionUpgrade | Enables or disables automatic minor version upgrades for a StarRocks instance. |
| UpdateBackup | UpdateBackup | Updates the description of a backup job. |
| UpdateBackupPolicy | UpdateBackupPolicy | Updates a backup policy. |
| UpdateInnerIpWhitelistGroup | UpdateInnerIpWhitelistGroup | Updates the CIDR blocks in a whitelist group. |
| UpdateInstanceName | UpdateInstanceName | Modifies the name of an E-MapReduce (EMR) Serverless StarRocks instance. |
| UpdateNodeGroupDescription | UpdateNodeGroupDescription | Updates the description of a compute group. |
| UpdatePublicNetworkStatus | UpdatePublicNetworkStatus | Enable or disable the Internet-facing SLB for the FE or BE component. |
该文章对您有帮助吗？