StartInstances

更新时间:
复制 MD 格式

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

Operation description

This operation is an asynchronous operation. After you call this operation to start ECS instances, the operation sets the status of the ECS instances to Starting and begins the startup process. You can call the DescribeInstanceStatus operation to query the status of the instances. When the status of the ECS instances changes to Running, the instances are started.

Precautions

  • You cannot call this operation to start ECS instances that are locked for security reasons. For more information, see API behavior when an instance is locked for security reasons.

  • The ECS instances that you want to start must be in the Stopped (Stopped) state.

  • ECS instances stopped in economical mode may fail to be started due to insufficient resources.

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

ecs:StartInstances

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None None

Request parameters

Parameter

Type

Required

Description

Example

DryRun

boolean

No

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

RegionId

string

Yes

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

cn-hangzhou

BatchOptimization

string

No

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

InstanceId

array

Yes

The IDs of ECS instances. Valid values of N: 1 to 100.

i-bp67acfmxazb4p****

string

No

The ID of ECS instance N.

i-bp67acfmxazb4p****

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

InstanceResponses

object

InstanceResponse

array<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.

object

Code

string

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

Message

string

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

InstanceId

string

The ID of the ECS instance.

i-bp67acfmxazb4p****

CurrentStatus

string

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

Starting

PreviousStatus

string

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

Stopped

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK needs to be added ECS tag
400 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service account have no right to access your KMS.
400 DRYRUN.SUCCESS This request is a dryrun request with successful result. The request is checked and determined as valid.
400 Invalid.PrivatePoolOptions.NoStock The PrivatePool has been used up. The capacity of the specified private pool (elastic assurance, capacity reservation) has been used up.
500 InternalError The request processing has failed due to some unknown error.
403 InvalidInstanceId.NotFound InstanceId should not be null.
403 InvalidParameter.TooManyInstanceIds Instance ids cannot be more than 100. InstanceIds cannot be more than 100.
403 Abs.InvalidInstanceIds.MalFormed The specified instanceIds is not valid.
403 InstanceExpired %s The instance is out of date and the operation cannot be performed.
403 InstanceLockedForSecurity %s
403 InstanceExpiredOrInArrears %s
403 IncorrectInstanceStatus %s The instance is in a state that does not support the current operation.
403 InvalidInstance.NotFoundSystemDisk %s
403 OperationDenied.SpotPriceLowerThanPublicPrice The spot instance price is lower than public price. Your user-defined maximum hourly price of a spot instance is lower than the current market price.
403 InsufficientBalance Your account does not have enough balance.
403 InstanceNotReady The specified instance is not ready for use.
403 OperationDenied.HostRepairing %s
403 OperationDenied.NoStock The requested resource is sold out in the specified zone, try other types of resources or other regions and zones. The requested resources are sold out in the specified zone. Try another instance type or zone.
404 InvalidInstanceId.NotFound %s
404 InvalidInstanceIds.NotFound The 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.
503 LimitedOperation.ServiceUnavailable The service is currently unavailable. Please try again later. The service is currently unavailable. Please try again later.
409 InvalidOperation.Conflict Request was denied due to conflict with a previous request, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.