You can call this operation to start an ECS instance. After the call of the operation succeeds, the instance enters the starting state.

Description

When you call this operation, note that:

  • The ECS instance must be in the Stopped state (Stopped).
  • If an ECS instance is under security control and its OperationLocks is set to "LockReason" : "security", you cannot start the instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
InstanceId String Yes i-bp67acfmxazb4ph***

The ID of the instance.

Action String No StartInstance

The operation that you want to perform. Set the value to StartInstance.

DryRun Boolean No true

Specifies whether to check this request only. Default value: false. Valid values:

  • True: Only this request is checked and the instance is not started. Check items include whether your AccessKey pair is valid, whether RAM users are authorized, and whether the required parameters are specified. If the check fails, the corresponding error message is returned. If the check succeeds, the DryRunOperation error code is returned.
  • false: This request is checked. A 2XX HTTP status code is returned and the instance is started if the check succeeds.
InitLocalDisk Boolean No true

Specifies whether to restore the instance to its initial health status. It is applicable to those instances of the instance families that contain local disks such as d1, i1, and i2. If a local disk of the d1, i1, or i2 instance family fails, you can use this parameter to specify whether to restore the instance to its initial health status at the startup of the instance. Default value: false. Valid values:

  • true: Restore the instance to its initial health status at the startup of the instance. After that, the data in the original local disks of the instance is lost.
  • false: No operation is made and the instance remains the current status.
OwnerAccount String No ECSforCloud@Alibaba.com

The logon name of a RAM user.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=StartInstance
&InstanceId=i-bp67acfmxazb4ph***
&InitLocalDisk=true
&<Common request parameters>

Sample success responses

XML format

<StartInstanceResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</StartInstanceResponse>

JSON format

{
	"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code Error code Error message Description
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. The error message returned because the specified value of the InstanceId parameter does not exist.
403 IncorrectInstanceStatus The current status of the resource does not support this operation. The error message returned because the operation is not supported while the resource is in the current state.
403 InstanceLockedForSecurity The specified operation is denied as your instance is locked for security reasons. The error message returned because the operation is not supported while the instance is locked for security reasons.
403 InsufficientBalance Your account does not have enough balance. The error message returned because your account balance is insufficient. You must top up your account before proceeding.
500 InstanceNotReady The specified instance is not ready for use The error message returned because the specified instance cannot be connected for the moment. Try again later.
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred. Try again later. If the problem persists, submit a ticket.
403 DiskError IncorrectDiskStatus. The error message returned because the specified disk status is invalid.
403 InstanceExpired The postPaid instance has been expired.Please ensure your account have enough balance. The error message returned because the pay-as-you-go instance is stopped due to overdue payments.
403 InstanceExpired The prePaid instance has been expired. The error message returned because the subscription instance is stopped due to overdue payments.
403 InstanceNotReady The specified instance is not ready for use. The error message returned because the operation is not supported while the resource is in the current state. Try the operation again after a few minutes.
403 DiskInArrears The specified operation is denied as your disk has expired. The error message returned because the disk has expired due to overdue payments.
403 OperationDenied.NoStock The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. The error message returned because the requested resources are insufficient.
403 OperationDenied.SpotPriceLowerThanPublicPrice The spot instance price is lower than public price. The error message returned because the spot price of a preemptible instance is lower than the price of the corresponding pay-as-you-go instance.
403 IncorrectInstanceStatus %s The error message returned because the operation is not supported while the instance is in the current state.
403 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service have no right to access your KMS. The error message returned because ECS is not authorized to access your KMS resources.
500 InternalError The request processing has failed due to some unknown error, exception or failure. The error message returned because an unknown error has occurred.

For a list of error codes, visit the API Error Center.