# Alibaba Cloud EMR Serverless StarRocks API

> Alibaba Cloud EMR Serverless StarRocks API on Apizie: 94 endpoints (Creates a backup policy, Creates a gateway, This operation changes the resource group of a Serverless StarRocks instance, Check the inventory of resources, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-starrocks/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-starrocks`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/starrocks
- Page: https://www.apizie.tech/api/cloud/aliyun-starrocks
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-starrocks/openapi.json

Alibaba Cloud OpenAPI for EMR Serverless StarRocks (starrocks, version 2022-10-19). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a backup policy
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/add-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| ExpireDays | integer | no | The number of days that the backup data remains valid |
| Hour | integer | no | The hour |
| InstanceId | string | no | The instance ID |
| Minute | integer | no | The minute |
| RecurrenceType | string | no | Specifies the execution type of the time rule. Valid values: DAILY: Repeats daily. WEEKLY: Repeats weekly. MONTHLY: Repeats monthly |
| RecurrenceValues | array | no | The values for the policy execution cycle |
| TimeoutSeconds | integer | no | The timeout period for the backup task, in seconds |

### Creates a gateway
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/add-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the instance |
| GatewayName | string | no | The alias for the private gateway |
| FeNodeNumber | integer | no | The number of gateway nodes |

### This operation changes the resource group of a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| NewResourceGroupId | string | yes | The ID of the destination resource group |
| RegionId | string | no | The ID of the region where the cluster resides |
| ResourceType | string | yes | The resource type. Only instance is supported |
| InstanceId | string | yes | The instance ID |

### Check the inventory of resources
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/check-inventory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| ZoneId | string | no | Zone |
| ClusterInfo | string | no | Cluster information |

### Creates an agent compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/create-agent-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| PayType | string | yes | The billing method. Valid values: prePaid: subscription. postPaid: pay-as-you-go. |
| Duration | integer | no | The subscription duration. This parameter is valid only when PayType is set to prePaid |
| PricingCycle | string | no | The unit of the subscription duration. Valid values: Month Year This parameter is valid only when PayType is set to prePaid |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter is valid only when PayType is set to prePaid. Default value: false |
| SpecType | string | no | The specification type of the compute group |
| Cu | integer | yes | The number of compute units (CUs). A CU is the basic metering unit of the service. One CU equals one vCPU and 4 GiB of memory. If SpecType… |
| InstanceId | string | yes | The instance ID |
| PromotionOptionNo | string | no | The coupon ID |

### Creates a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/create-instance-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| AdminPassword | string | yes | The password of the instance administrator |
| AgentNodeGroup | object | no | The agent compute group |
| AutoPay | string | no | Specifies whether automatic payment is enabled for all products specified in the Products parameter. Valid values: true: Enables automatic… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter takes effect only when PayType is set to PrePaid. Default value: false |
| BackendNodeGroups | array | no | The information about the BE or CN compute groups |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |
| DlfCatalogName | string | no | The name of the DLF catalog |
| DlfCatalogType | string | no | The type of the DLF catalog, such as paimon or iceberg |
| Duration | integer | no | The subscription duration. This parameter takes effect only when PayType is set to PrePaid |
| EnableAiFunction | string | no | Specifies whether to enable the AI center. Default value: false |
| EnableMultiAz | string | no | Specifies whether to enable disaster recovery |
| Encrypted | string | no | Specifies whether to enable encryption |
| FrontendNodeGroups | array | no | The information about the FE node groups |
| GatewayType | string | no | The gateway type. Generally, the value is Slb or Privatezone |
| InstanceName | string | yes | The instance name |
| KmsKeyId | string | no | The KMS key ID |
| LinkedRamUserName | string | no | The username of the associated Resource Access Management (RAM) user or the name of the RAM role |
| ObserverNodeGroups | array | no | The information about the Observer compute group. Specify this parameter only when you need to enable multi-zone disaster recovery. The… |
| OssAccessingRoleName | string | no | The name of the role used for password-free access to OSS |
| PackageType | string | yes | The instance edition. Valid values: trial: Trial Edition. official: Standard Edition. |
| PayType | string | yes | The billing method of the instance. Valid values: prePaid: subscription. postPaid: pay-as-you-go. |
| PricingCycle | string | no | The unit of the billing cycle. Valid values: Month Year This parameter takes effect only when PayType is set to PrePaid |
| PrincipalType | string | no | The RAM authentication type. A value of RS indicates a Resource Access Management (RAM) user, and a value of RR indicates a RAM role |
| PromotionOptionNo | string | no | The coupon ID |
| RamUserId | string | no | The ID of the Resource Access Management (RAM) user or RAM role |
| RegionId | string | yes | The region ID |
| ResourceGroupId | string | no | The resource group ID |
| RunMode | string | yes | The run mode of the cluster. Valid values: shared_nothing: shared-nothing architecture. shared_data: shared-data architecture. |
| Tags | array | no | The tags of the instance |
| VSwitches | array | no | The vSwitch and zone information |
| Version | string | yes | The major version of the instance |
| VpcId | string | yes | The VPC ID |
| ZoneId | string | yes | The primary zone ID |

### Creates an elastic rule
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/create-scaling-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| NodeGroupId | string | yes | The compute group ID |
| TriggerType | string | yes | The trigger type |
| Rule | string | yes | The rule content |
| InstanceId | string | no | The instance ID |

### This operation creates the AliyunServiceRoleForEMRStarRocks role
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/create-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |

### Deletes a data backup
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/delete-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| BackupTaskId | string | yes | The backup task ID |
| InstanceId | string | yes | The instance ID |

### Deletes a backup policy
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/delete-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | Instance ID |
| PolicyId | string | no | Policy ID |

### Deleting a gateway
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/delete-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| GatewayId | string | no | The gateway ID |

### Deletes an internal network whitelist group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/delete-inner-ip-whitelist-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InnerIpWhitelistGroupId | string | yes | Internal network whitelist group name |
| InstanceId | string | yes | Instance ID |

### Deletes an elastic scaling rule
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/delete-scaling-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| NodeGroupId | string | yes | The node group ID |
| ScalingRuleId | string | yes | The ID of the scaling rule to be deleted |
| TriggerType | string | yes | The trigger type |
| InstanceId | string | no | The instance ID |

### Queries the available zones in a region
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-available-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |

### Retrieves the details of a backup policy
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-backup-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance |
| InstanceId | string | no | The instance ID |
| PolicyId | string | no | The policy ID |

### Retrieves the details of a backup
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance |
| InstanceId | string | no | The instance ID |
| BackupTaskId | string | no | The backup task ID |
| Statuses | string | no | The list of statuses |
| TimePeriodStartTime | integer | no | The start time of the backup task query. The time is a UNIX timestamp in seconds |
| TimePeriodEndTime | integer | no | The end time of the backup task query. The time is a UNIX timestamp in seconds |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page in a paging query |

### Queries the configuration history of an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-config-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NeedTotal | string | no | Specifies whether to return all configurations |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paging query. Default value: 10 |
| StartTime | integer | no | The start time of the modification history. The time is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the modification history. The time is a UNIX timestamp in milliseconds |
| EffectStatuses | string | no | The effective status |

### Retrieve the cluster event name
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-event-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |

### Describes the whitelist groups for a private network
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-inner-ip-whitelist-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries instance configurations
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-instance-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ConfigType | string | no | The type of the configuration item. Valid values: FE BE CORE |
| ConfigKey | string | no | The key of the configuration item |
| Description | string | no | The description of the configuration item's feature |
| AllowModify | string | no | Indicates whether the configuration item can be modified |
| NeedTotal | string | no | Indicates whether to return all configuration items |
| PageNumber | integer | no | The page number for the query. The default value is 1 |
| PageSize | integer | no | The number of entries per page for a paged query. The default value is 20 |
| NodeGroupId | string | no | The compute group ID |

### Retrieves the health diagnosis results of an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-instance-diagnosis-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number for paging. Default value: 1 |
| PageSize | integer | no | The number of authorization entries returned per page when paging. Default value: 10. Maximum value: 50 |
| InstanceId | string | no | The instance ID |
| Dimension | string | no | The evaluation dimension |
| Statuses | string | no | The status collection |
| ReportDate | string | no | The report date in the YYYY-MM-DD format |

### Obtains the meta token for a StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-instance-meta-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |

### Queries Serverless StarRocks instances and supports filtering by instance name or tags
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceName | string | no | The instance name |
| InstanceId | string | no | The instance ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page for paging in a paged query |
| RegionId | string | no | The region ID of the instance |
| InstanceStatus | string | no | The instance status. You can specify multiple statuses separated by commas. Valid values: unpaid: Unpaid. paid: Paid. creating: Starting.… |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The tags (JSON-encoded) |

### Retrieves node group information
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-node-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number for a paged query. Default value: 1 |
| PageSize | integer | no | The number of entries per page for a paged query. Default value: 10 |
| ClusterId | string | no | The instance ID |
| componentType | string | no | The compute group type. Valid values: FE BE CN OBSERVER AGENT |
| instanceId | string | no | [Deprecated] The instance ID |
| nodeGroupIds | array | no | The list of compute group IDs to query |
| nodeGroupName | string | no | The compute group name |
| status | string | no | The compute group status. Valid values: UNPAID: Unpaid. PAID: Paid. CREATING_FAILED: Creation failed. CREATING: Creating. RUNNING:… |
| tags | array | no | The list of tags |

### You can view the list of available regions
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |

### Retrieves the resource constraint configuration
`GET https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-resource-constraints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| PackageType | string | no | The instance edition. Valid values: trial: Trial edition. official: Standard edition |
| RunMode | string | no | The running mode of the cluster. Valid values: shared_nothing: Integrated storage and compute. shared_data: Separated storage and compute.… |
| Architecture | string | no | The instance architecture. Valid values: onEci: Deployed on ECI. onEcs: Deployed on ECS. onBareMetal: Deployed on a bare metal resource pool |

### Obtain the system time zone of a StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-system-timezone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the details of time-triggered scaling rules
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/describe-time-trigger-scaling-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| NodeGroupId | string | no | The ID of the compute group |

### Disables SSL for a StarRocks connection
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/disable-sslconnection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the instance |

### Enables the internal Server Load Balancer (SLB) for the default gateway of an EMR Serverless StarRocks…
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/enable-internal-slb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID of the EMR Serverless StarRocks instance |

### Enables Multi-AZ deployment
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/enable-multi-az` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | Instance ID |
| observers | array | no | Multi-zone information |
| promotionOptionNo | string | no | Coupon |

### Enables SSL for a StarRocks connection
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/enable-sslconnection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| CustomSSLCertificate | string | no | Custom SSL certificate |
| EnableCustom | string | no | Specifies whether to use a custom certificate |
| InstanceId | string | no | Instance ID |
| Renewal | string | no | Indicates whether this request renews an existing certificate |
| SslKeyPassword | string | no | Key password |
| SslKeystorePassword | string | no | Keystore password |

### Retrieves the feature switches of a StarRocks cluster instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/get-instance-feature-gate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieve the feature gate for a StarRocks compute group instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/get-node-group-feature-gate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| NodeGroupId | string | yes | Compute group ID |

### Enable read/write splitting. The Leader FE node handles write requests, and other nodes handle read requests
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/isolate-leader` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| IsolateLeader | string | no | Enable read/write splitting. The Leader FE node handles write requests, and other nodes handle read requests |

### Lists gateways
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/list-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |

### Retrieves the details of an operation
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/list-operation-activity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| OperationId | string | no | The operation ID |

### Queries the operation history of a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/list-operation-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number of the current page. Default value: 1 |
| PageSize | integer | no | The number of entries per page for paging in a paged query. Default value: 10 |
| InstanceId | string | yes | The instance ID |
| OperationId | string | no | The operation ID |
| OperationType | string | no | The operation type. Valid values: trial_to_official: Upgrades the trial edition to the standard edition. upgrade_version: Upgrades the… |
| OperationStatus | string | no | The operation status. Valid values: COMPLETED: Completed. TERMINATED: Terminated. HUMAN_PROCESSING: Pending manual processing |
| StartTime | integer | no | The start time of the operation. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the operation. The value is a UNIX timestamp in milliseconds |

### Retrieves the ssl certificate details for a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/list-ssldetails` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Change the billing method for an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-charge-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | Cluster ID |
| AutoRenew | string | no | Whether to enable auto-renewal. This parameter takes effect only when payType is PrePaid. Default: disabled |
| Duration | string | no | Subscription duration. This parameter takes effect only when payType is PrePaid |
| PricingCycle | string | no | Subscription duration unit: Month Year This parameter takes effect only when payType is PrePaid |
| BillingInstanceIds | string | no | List of billing instance IDs that require renewal. Separate multiple IDs with commas |
| PromotionOptionNo | string | no | Coupon ID |

### Modifies the number of compute units (CUs) for compute group nodes in a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-cu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target number of CUs |
| FastMode | string | no | Specifies whether to restart in fast restart mode. Default value: false. Valid values: true: Restarts the compute nodes in fast restart… |
| PromotionOptionNo | string | no | The coupon ID |
| AutoPay | string | no | Specifies whether to automatically pay for all products specified in the Products parameter. Valid values: true: Enables automatic… |

### Checks whether the number of compute units (CUs) for nodes in the FE, BE, or CN compute group of a…
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-cu-pre-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target number of CUs |

### Increases the number of disk blocks for a compute group node in a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-disk-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target number of disks |
| FastMode | string | no | Specifies whether to use the fast restart mode. Default value: false. true: Restarts compute nodes in fast restart mode. Compute nodes are… |
| PromotionOptionNo | string | no | The coupon ID |
| AutoPay | string | no | Specifies whether to automatically purchase (pay for) all products specified in the Products parameter. true: Automatic payment. false: No… |

### Modifies the disk performance level (PL) of nodes in a compute group of a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-disk-performance-level` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | string | yes | The target disk performance level (PL) |
| PromotionOptionNo | string | no | The coupon ID |
| AutoPay | string | no | Specifies whether automatic payment is enabled for all products specified in the Products parameter. Valid values: true: automatic… |

### Scales up the disk capacity of compute group nodes in a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-disk-size` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target disk size. Unit: GB |
| PromotionOptionNo | string | no | The coupon ID |
| FastMode | string | no | Specifies whether to use the fast restart mode for restart. Default value: false. true: Restarts compute nodes in fast restart mode.… |
| AutoPay | string | no | Specifies whether to automatically purchase (pay for) all products specified in the Products parameter. true: Automatic payment. false: No… |

### Modifies the node disk type of a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-disk-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| TargetPerformanceLevel | string | yes | The target disk performance |
| TargetDiskType | string | yes | The target disk type |
| PromotionOptionNo | string | no | The coupon ID |
| AutoPay | string | no | Specifies whether to automatically pay for all products specified in the Products parameter. Valid values: true: Automatic payment. false:… |

### Modifies the /etc/hosts file
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-host-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| hostAliases | array | no | Host alias list |
| InstanceId | string | no | Instance ID |

### This API modifies the configuration of a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Sample ID |
| ConfigList | string | no | Additional information |
| Reason | string | no | Reason for modification |
| AddConfigList | string | no | [Deprecated] List of configurations to add |
| DeleteConfigList | string | no | [Deprecated] List of configurations to delete |
| configsToAdd | array | no | Configurations to add |
| configsToDelete | array | no | Configurations to delete |
| configsToUpdate | array | no | Configurations to update |
| fastMode | string | no | Whether to restart quickly |
| restart | string | no | Whether to restart |

### This operation pre-checks modifications to the instance configuration of a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-instance-config-pre-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| configsToAdd | array | no | The configurations to add |
| configsToDelete | array | no | The configurations to delete |
| configsToUpdate | array | no | The configurations to update |

### Modifies the maintenance window for a StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-maintainable-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| MaintainableTimePeriod | string | yes | The maintenance window for the instance |

### Modifies the number of nodes in a compute group of a Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-node-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target number of nodes |
| PromotionOptionNo | string | no | The coupon ID |
| Parallelism | integer | no | The decommission concurrency for BE scale-in scenarios in compute-storage coupled mode. Default value: 1 |
| TerminationGracePeriodSeconds | integer | no | The wait time for running tasks to complete before dropping nodes during CN scale-in scenarios in compute-storage decoupled mode |
| AutoPay | string | no | Specifies whether to automatically purchase (pay for) all products specified in the Products parameter. Valid values: true: Automatic… |

### Performs a precheck before you modify the number of nodes in a warehouse of an E-MapReduce (EMR) Serverless…
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-node-number-pre-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The warehouse ID |
| Target | integer | yes | The number of nodes to which you want to change to |

### Modifies an elastic scaling rule
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-scaling-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| NodeGroupId | string | yes | The ID of the compute group |
| OldTriggerType | string | yes | The original trigger type |
| NewTriggerType | string | yes | The new trigger type |
| ScalingRuleId | string | yes | The ID of the scaling rule to be modified |
| Rule | string | yes | The content of the rule |
| InstanceId | string | no | The instance ID |

### Modifies the node specification type of a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-spec-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| TargetSpecType | string | yes | The target specification type |
| FastMode | string | no | Specifies whether to restart in fast restart mode. Default value: false. true: Restarts compute nodes in fast restart mode. Compute nodes… |
| PromotionOptionNo | string | no | The coupon ID |
| AutoPay | string | no | Specifies whether to automatically pay for all products specified in the Products parameter. true: Automatic payment. false: No automatic… |

### Performs a dry run for modifying the node specifications type in a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-spec-type-pre-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| TargetSpecType | string | no | The target specification type |

### Modifies the password for a StarRocks user
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/modify-user-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| Password | string | no | The client's new password |
| InstanceId | string | no | The instance ID |

### Queries the price for enabling multi-zone deployment
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-enable-multi-az-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | The instance ID |
| observers | array | no | The list of observers |
| promotionOptionNo | string | no | The coupon |

### Queries the latest minor version for the current major version
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-minor-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the cluster |
| Version | string | no | The major version of the instance |

### Queries the price for changing the billing method of a StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-charge-type-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The cluster ID |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter is valid only when \`payType\` is set to \`PrePaid\`. The default value is false |
| Duration | string | no | The subscription duration. This parameter is valid only when \`payType\` is set to \`PrePaid\` |
| PricingCycle | string | no | The unit of the subscription duration: Month Year This parameter is valid only when \`payType\` is set to \`PrePaid\` |
| BillingInstanceIds | string | no | A list of billing instance IDs to modify. Separate multiple IDs with commas |
| PromotionOptionNo | string | no | The coupon ID |

### Queries the price for modifying the compute units (CUs) of a compute group node
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-cu-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target CU count |
| PromotionOptionNo | string | no | The coupon ID |

### Retrieve the price for changing the number of disks in a compute group node
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-disk-number-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| NodeGroupId | string | yes | The ID of the compute group |
| Target | integer | yes | The target number of nodes |
| PromotionOptionNo | string | no | The ID of the coupon |

### Queries the price of changing the disk performance level for a compute group node
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-disk-performance-level-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | string | yes | The target disk performance level |
| PromotionOptionNo | string | no | The coupon ID |

### Queries the price for modifying the disk size of a single node in a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-disk-size-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| NodeGroupId | string | yes | Compute group ID |
| Target | integer | yes | Target disk size. Unit: GB |
| PromotionOptionNo | string | no | Coupon ID |

### Queries the price for modifying the disk type of nodes in a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-disk-type-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| NodeGroupId | string | yes | Compute group ID |
| TargetPerformanceLevel | string | yes | Target disk performance |
| TargetDiskType | string | yes | Target disk type |
| PromotionOptionNo | string | no | Coupon ID |

### Queries the price for changing the number of nodes in a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-node-number-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| Target | integer | yes | The target number of nodes |
| PromotionOptionNo | string | no | The coupon ID |

### Queries the price to change the specification type of a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-modify-spec-type-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeGroupId | string | yes | The compute group ID |
| TargetSpecType | string | yes | The node type of the compute group |
| PromotionOptionNo | string | no | The coupon ID |

### An API for querying the price of new StarRocks purchases
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-price-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| AgentNodeGroup | object | no | Agent compute group |
| BackendNodeGroups | array | no | BE or CN compute group information |
| Duration | integer | no | Subscription duration. Valid only when PayType is prePaid |
| FrontendNodeGroups | array | no | FE node group information |
| ObserverNodeGroups | array | no | Observer compute group information |
| PackageType | string | no | Instance edition: Trial Edition (trial). Standard Edition (official) |
| PayType | string | no | Payment type: Subscription (prePaid). Pay-as-you-go (postPaid) |
| PricingCycle | string | no | Subscription duration unit: Month (Month) Year (Year) Valid only when PayType is prePaid |
| PromotionOptionNo | string | no | Coupon ID |
| RegionId | string | no | Region ID |
| RunMode | string | no | Cluster run mode: Shared-nothing (shared_nothing). Shared-data (shared_data) |

### Pricing information for unsubscribing from StarRocks subscription instances
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-refund-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| billingInstanceIds | string | no | A comma-separated list of instance IDs to cancel |
| instanceId | string | no | The instance ID. This field is deprecated |

### Query the renewal price for a StarRocks billing instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-renew-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Duration | integer | yes | Renewal period |
| PricingCycle | string | yes | Renewal unit |
| BillingInstanceIds | string | yes | List of billing instance IDs to renew. Separate multiple IDs with commas |
| PromotionOptionNo | string | no | Coupon ID |

### Queries the unpaid orders of a compute group or cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-unpaid-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| BillingInstanceId | string | yes | The ID of the instance that is associated with the bill. For the default compute group, which includes the FE compute group and the… |
| OrderType | string | no | Order type |

### Queries the available upgrade versions for an EMR Serverless StarRocks instance. StarRocks instances have…
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/query-upgradable-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Minor | string | no | Specifies whether to query the minor versions that you can upgrade to. Default value: true. Valid values: true: The minor versions that… |

### Reboot ECS instances in a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/reboot-ecs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RebootTime | integer | no | The reboot time for the instance |
| EventId | string | no | The system event ID |
| InstanceId | string | no | The instance ID |

### Releases a pay-as-you-go E-MapReduce (EMR) Serverless StarRocks instance. To unsubscribe from a subscription…
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/release-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Renews an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/renew-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Duration | integer | yes | The subscription duration |
| PricingCycle | string | yes | Duration unit: Month Year Valid only when payType is PrePaid |
| BillingInstanceIds | string | yes | A comma-separated list of billing instance IDs to renew. Billing instances include clusters and compute groups |
| PromotionOptionNo | string | no | The coupon ID |

### Restarts an E-MapReduce (EMR) Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/restart-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| FastMode | string | no | Specifies whether to restart compute nodes in quick restart mode. Default value: false. Valid values: true: Compute nodes are restarted in… |

### Restarts a specified node group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/restart-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the instance |
| NodeGroupId | string | no | The ID of the compute group |
| FastMode | string | no | Whether to restart in fast mode. Default value: false. true: Restart compute nodes in fast mode. Nodes restart in batches. Within each… |

### Restart nodes in a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/restart-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| RestartNodeGroups | array | no | Information about compute group nodes to restart |

### Restore an instance from a backup
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/restore-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| AdminPassword | string | no | Cluster administrator password |
| AutoRenew | string | no | Enable auto-renewal. This parameter applies only when PayType is prePaid. Default: false |
| BackupTaskId | string | no | Backup job ID |
| Duration | integer | no | Subscription duration. This parameter applies only when PayType is prePaid |
| InstanceName | string | no | Instance name |
| PayType | string | no | Payment type: prePaid for subscription postPaid for pay-as-you-go |
| PricingCycle | string | no | Billing cycle unit. This parameter applies only when PayType is prePaid. Month for monthly billing Year for yearly billing |
| RegionId | string | no | Region ID |
| ResourceGroupId | string | no | Resource group ID |
| Tags | array | no | Tag struct |
| VSwitches | array | no | VSwitch and zone information |
| VpcId | string | no | VPC ID |

### Resumes an instance automatically stopped by openlake
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/resume-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Rolls back a configuration modification that is currently in progress
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/rollback-config-modification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| ConfigHistoryId | integer | no | The ID of the configuration modification history |
| Restart | string | no | Specifies whether to restart the instance after the configuration is changed. Valid values: true: Restart the instance. false: Do not… |

### Switches the active and standby zones
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/switch-active-standby-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| TargetZoneId | string | no | The ID of the target zone |

### Attaches tags to specified resources
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceId | array | yes | A list of resource IDs. The list can contain up to 50 IDs |
| ResourceType | string | yes | The resource type |
| Tag | array | yes | A list of tags to add. The list can contain up to 20 tags |

### Enables or disables automatic minor version upgrades for a StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/toggle-auto-minor-version-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AutoUpgrade | string | yes | Specifies whether to enable automatic minor version upgrades. Valid values: true: Enables automatic upgrades. false: Disables automatic… |

### Switches an Internet-facing SLB instance on or off
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/toggle-public-slb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | Instance ID |
| GatewayId | string | no | Private gateway ID |
| EnablePublicSlb | string | no | Is Internet-facing SLB enabled? Enable: true Disable: false |

### Detaches tags from multiple resources
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/un-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type |
| ResourceId | string | yes | A list of resource IDs. The list can contain up to 50 resource IDs (JSON-encoded) |
| TagKey | string | no | A list of tag keys to remove. The list can contain up to 20 tag keys (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags from the resources. This parameter is valid only when the TagKey parameter is left empty. The default… |

### Updates the description of a backup job
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the cluster is located |
| backupTaskId | string | no | The ID of the backup job |
| description | string | no | The description of the backup |

### Updates a backup policy
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| ExpireDays | integer | no | Validity period in days |
| Hour | integer | no | Trigger time: hour |
| InstanceId | string | no | Instance ID |
| Minute | integer | no | Trigger time: minute |
| PolicyId | string | no | Backup policy ID |
| RecurrenceValues | array | no | Numerical values for the policy execution cycle |
| TimeoutSeconds | integer | no | Timeout duration for the backup policy |

### Updates the number of gateway nodes
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the instance |
| GatewayId | string | no | The ID of the gateway |
| GatewayName | string | no | The name of the gateway |
| FeNodeNumber | integer | no | The number of gateway nodes |

### Updates the CIDR blocks in a whitelist group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-inner-ip-whitelist-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| CidrIpList | array | yes | The list of CIDR blocks for the whitelist |
| InnerIpWhitelistGroupId | string | yes | The ID of the private network whitelist group |
| InstanceId | string | yes | The instance ID |

### Modifies the name of an E-MapReduce (EMR) Serverless StarRocks instance
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| ClusterName | string | yes | The new name of the instance |
| InstanceId | string | yes | The instance ID |

### Updates the description of a compute group
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-node-group-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| NodeGroupId | string | no | The ID of the compute group |
| Description | string | no | The description of the compute group |
| X-Acs-Ram-Auth-Context | string | no | The RAM authorization information |

### Enables or performs shutdown of the Internet-facing SLB for FE and BE nodes
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/update-public-network-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The returned data |
| ComponentType | string | no | The returned data |
| PublicNetworkEnabled | string | no | Specifies whether to enable or disable Internet access |
| NodeGroupId | string | no | The ID of the compute group |

### Upgrades the version of a Serverless StarRocks instance. Serverless StarRocks has two levels of version…
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/upgrade-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TargetVersion | string | yes | The target version number |
| Minor | string | no | Specifies whether this upgrade is a minor version upgrade. Default value: true. Valid values: true: minor version upgrade. false: major… |
| FastMode | string | no | Specifies whether to perform a fast restart |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://starrocks.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-starrocks/add-backup-policy" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud EMR Serverless StarRocks API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-starrocks/add-backup-policy with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud EMR Serverless StarRocks API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud EMR Serverless StarRocks itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud EMR Serverless StarRocks API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-starrocks.

### What is the status of the Alibaba Cloud EMR Serverless StarRocks API?
Needs your own provider key (bring your own key)