本接口用于升级 Serverless StarRocks 实例版本。Serverless StarRocks 有两层版本定义,一层是主版本,即集群详情页“版本”所显示的内容,另一层是小版本,即集群详情页“小版本”所显示的内容。本接口既可以用于升级小版本,也可以用于升级主版本。 可以使用接口 QueryUpgradableVersions 查询集群的可升级版本。
接口说明
调用该接口时实例必须处于运行中(Running)状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| sr:UpgradeVersion | update | *Instance acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId} | 
 | 无 | 
请求语法
POST /webapi/starrocks/upgradeVersion HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID。 | c-b25e21e24388**** | 
| TargetVersion | string | 是 | 目标版本号。 | 3.3.2-1.77-1.6.4 | 
| Minor | boolean | 否 | 本次升级是否为小版本升级。默认值为 true 即升级小版本。 
 | true | 
返回参数
示例
正常返回示例
JSON格式
{
  "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"
  }
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2025-02-20 | OpenAPI 入参发生变更 | 查看变更详情 | 
