RestartInstance - 重启实例

本接口用于重启 Serverless StarRocks 实例。

接口说明

该接口为异步接口,实例的重启不是立即完成的,成功调用后,实例会先进入重启中(restarting)状态,当返回的状态为运行中(running)时代表重启成功。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sr:RestartInstancenone
*Instance
acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

POST /webapi/starrocks/restartCluster HTTP/1.1

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

c-b25e21e24388****
FastModeboolean

是否以快速重启模式重启。默认为 false。

  • true:以快速重启模式重启计算节点。分为多个批次重启计算节点,批次内并行重启,批次间串行执行;
  • false:以滚动重启模式重启计算节点。
true

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 请求状态码。

200
RequestIdstring

请求 ID。

32A44F0D-BFF6-5664-999A-218BBDE7****
Successboolean

请求是否成功。

false
ErrCodestring

错误码。

InvalidParams
ErrMessagestring

错误信息。

Unsupported.Non.Whitelist.Operation
Databoolean

返回数据。

true
AccessDeniedDetailstring

权限校验失败详情。

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
  "Success": false,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Unsupported.Non.Whitelist.Operation",
  "Data": true,
  "AccessDeniedDetail": {
    "PolicyType": "AccountLevelIdentityBasedPolicy",
    "AuthPrincipalOwnerId": "xxx",
    "EncodedDiagnosticMessage": "xxx",
    "AuthPrincipalType": "xxx",
    "AuthPrincipalDisplayName": "xxx",
    "NoPermissionType": "ImplicitDeny",
    "AuthAction": "sr:xxx"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史