All Products
Search
Document Center

Elastic Compute Service:StartInstances

Last Updated:Sep 29, 2024

Starts Elastic Compute Service (ECS) instances that are in the Stopped state.

Operation description

When you call this operation, take note of the following items:

  • The ECS instances that you want to start must be in the Stopped state.``
  • If the response contains {"OperationLocks": {"LockReason" : "security"}}, the ECS instance is locked to ensure security. No operations are allowed on the ECS instance.
  • You can start multiple ECS instances at the same time and use the BatchOptimization parameter to specify the batch operation mode.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
ecs:StartInstancesupdate
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DryRunbooleanNo

Specifies whether to perform a dry run. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including required parameters, request syntax, and instance status. If the request fails the dry run, an error message is returned. If the request passes the dry run, DRYRUN.SUCCESS is returned.
Note If you set BatchOptimization to SuccessFirst and DryRun to true, only DRYRUN.SUCCESS is returned regardless of whether the request passes the dry run.
  • false: performs a dry run and performs the actual request. If the request passes the dry run, the operation is performed.

Default value: false.

false
RegionIdstringYes

The region ID of the ECS instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
BatchOptimizationstringNo

The batch operation mode. Valid values:

  • AllTogether: starts all ECS instances at the same time. If all ECS instances are started, a success message is returned. If an ECS instance fails to be started, all the specified instances fail to be started and an error message is returned.
  • SuccessFirst: separately starts each ECS instance. The response contains the operation results of each ECS instance.

Default value: AllTogether.

AllTogether
InstanceIdarrayYes

The IDs of the ECS instances. You can specify up to 100 ECS instance IDs.

stringYes

The ID of instance N. Valid values of N: 1 to 100.

i-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceResponsesarray<object>

The information about the ECS instance, such as the status of each instance before and after the operation is called and the operation results.

InstanceResponseobject
Codestring

The error code that is returned for the operation on the ECS instance. The value 200 indicates that the operation is successful. For more information, see the "Error codes" section in this topic.

200
Messagestring

The error message that is returned for the operation on the ECS instance. The value success indicates that the operation is successful. For more information, see the "Error codes" section in this topic.

success
InstanceIdstring

The ID of the ECS instance.

i-bp67acfmxazb4p****
CurrentStatusstring

The status of the ECS instance after the operation is called.

Starting
PreviousStatusstring

The status of the ECS instance before the operation is called.

Stopped

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp67acfmxazb4p****",
        "CurrentStatus": "Starting",
        "PreviousStatus": "Stopped"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be added ECS tag-
400InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK.
400InvalidParameter.KMSKeyId.KMSUnauthorizedECS service account have no right to access your KMS.-
400DRYRUN.SUCCESSThis request is a dryrun request with successful result.The request is checked and determined as valid.
400Invalid.PrivatePoolOptions.NoStockThe PrivatePool has been used up.-
403InvalidInstanceId.NotFoundInstanceId should not be null.-
403InvalidParameter.TooManyInstanceIdsInstance ids cannot be more than 100.-
403Abs.InvalidInstanceIds.MalFormedThe specified instanceIds is not valid.-
403InstanceExpired%s-
403InstanceLockedForSecurity%s-
403InstanceExpiredOrInArrears%s-
403IncorrectInstanceStatus%sThe instance is in a state that does not support the current operation.
403InvalidInstance.NotFoundSystemDisk%s-
403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.The requested resources are insufficient.
403OperationDenied.SpotPriceLowerThanPublicPriceThe spot instance price is lower than public price.Your user-defined maximum hourly price of a preemptible instance is lower than the current market price.
403OperationDenied.SpotPriceLowerThanPublicPrice%s-
403InsufficientBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403InstanceNotReadyThe specified instance is not ready for use.The resource is in a state that does not support the current operation. Try again later and check whether the instance state supports the operation.
403OperationDenied.HostRepairing%s-
404InvalidInstanceId.NotFound%sThe specified instance does not exist. Check whether the InstanceId parameter is valid.
404InvalidInstanceIds.NotFoundThe specified InstanceIds does not exist.The specified InstanceId parameter does not exist. You can call the DescribeInstances operation to query the state of the instance.
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
409InvalidOperation.ConflictRequest was denied due to conflict with a previous request, please try again later.-
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.

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

Change history

Change timeSummary of changesOperation
No change history