All Products
Search
Document Center

E-MapReduce:RestartInstance

Last Updated:Sep 16, 2025

Restarts an E-MapReduce (EMR) Serverless StarRocks instance.

Operation description

This operation is an asynchronous operation. After you call this operation to restart a StarRocks instance, the operation sets the status of the instance to Restarting and begins the restart process. When the status of the instance changes to Running, the instance is restarted.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sr:RestartInstancenone
*Instance
acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

POST /webapi/starrocks/restartCluster HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

c-b25e21e24388****
FastModebooleanNo

Specifies whether to restart compute nodes in quick restart mode. Default value: false. Valid values:

  • true: Compute nodes are restarted in quick restart mode in multiple batches. The batches are executed in parallel, and the nodes in each batch are restarted at the same time.
  • false: Compute nodes are restarted in rolling restart mode.
true

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID.

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

Indicates whether the request was successful.

false
ErrCodestring

The error code.

InvalidParams
ErrMessagestring

The error message.

Unsupported.Non.Whitelist.Operation
Databoolean

The returned data.

true
AccessDeniedDetailstring

The detailed information about the failed permission verification.

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

Examples

Sample success responses

JSONformat

{
  "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"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history