UpgradeVersion - E-MapReduce - Alibaba Cloud Documentation Center

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.

Operation description

You can call this API only when the instance is in the Running state.

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:UpgradeVersion

update

*Instance

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

None

Request syntax

POST /webapi/starrocks/upgradeVersion HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	c-b25e21e24388****
TargetVersion	string	Yes	The target version number.	3.3.2-1.77-1.6.4
Minor	boolean	No	Specifies whether to perform a minor version update. The default value is true. true: Perform a minor version update. false: Perform a major engine version upgrade.	true
FastMode	boolean	No

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP request status code.	200
RequestId	string	The request ID.	32A44F0D-BFF6-5664-999A-218BBDE7****
Success	boolean	Indicates whether the request was successful.	false
ErrCode	string	The error code.	InvalidParams
ErrMessage	string	The error message.	Invalid instance status: [cannot upgrade when instance is not running].
Data	boolean	The returned data.
AccessDeniedDetail	string	The details of the access denied error.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
  "Success": false,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid instance status: [cannot upgrade when instance is not running].",
  "Data": 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.