Starts an Elastic Compute Service (ECS) instance. After the operation is called, the instance enters the Starting state.

Usage notes

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

  • The ECS instances that you want to start must be in the Stopped (Stopped) state.
  • If OperationLocks in the response contains "LockReason" : "security" for an instance when you query the information of the instance, the instance is locked for security reasons and cannot be started.

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

ParameterTypeRequiredExampleDescription
ActionStringYesStartInstance

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

InstanceIdStringYesi-bp67acfmxazb4p****

The ID of the instance that you want to start.

InitLocalDiskBooleanNotrue

Specifies whether to restore the instance to its initial health state. This parameter is applicable to instances that are equipped with local disks, such as d1, i1, and i2 instances. If a local disk of a d1, i1, or i2 instance fails, you can use this parameter to specify whether to restore the instance to its initial health state on startup. Valid values:

  • true: restores the instance to its initial health state on startup. After the instance is restored to its initial health state, data stored on the local disks of the instance is lost.
  • false: does not perform operations and keeps the instance in the current state.

Default value: false.

DryRunBooleanNotrue

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks your AccessKey pair, the permissions of the RAM user, and the required parameters. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false: performs a dry run and sends the request. If the request passes the dry run, a 2XX HTTP status code is returned and the operation is performd.

Default value: false.

Response parameters

ParameterTypeExampleDescription
RequestIdString473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=StartInstance
&InstanceId=i-bp67acfmxazb4p****
&InitLocalDisk=true
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status codeError codeError messageDescription
403InvalidParameter.KMSKeyId.NotFoundThe specified KMSKeyId does not exist.The error message returned because the specified KMSKeyId parameter does not exist.
403IncorrectInstanceStatusThe 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.
403InstanceLockedForSecurityThe specified operation is denied as your instance is locked for security reasons.The error message returned because the instance is locked for security reasons.
403InsufficientBalanceYour account does not have enough balance.The error message returned because your account balance is insufficient. Add funds to your account and try again.
403DiskErrorIncorrectDiskStatus.The error message returned because the state of the specified disk is invalid.
403InstanceExpiredThe postPaid instance has been expired. Please ensure your account have enough balance.The error message returned because the pay-as-you-go instance has expired. When a pay-as-you-go instance is stopped due to an overdue payment, the instance enters the Expired state. Maintain a sufficient account balance.
403InstanceNotReadyThe 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 again later.
403DiskInArrearsThe specified operation is denied as your disk has expired.The error message returned because the disk has expired due to overdue payments.
403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.The error message returned because requested resources are unavailable in the specified zone. Try another instance type or zone. You can call the DescribeZones operation to query available resources in zones.
403OperationDenied.SpotPriceLowerThanPublicPriceThe spot instance price is lower than public price.The error message returned because the user-defined maximum hourly price of a preemptible instance is lower than the current market price.
403IncorrectInstanceStatus%sThe error message returned because the operation is not supported while the instance is in the current state.
403InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The error message returned because the customer master key (CMK) is not enabled when a KMS key ID is specified for a disk. You can call the DescribeKey operation of KMS to query the information about the specified CMK.
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.The error message returned because ECS is not authorized to access your KMS resources.
403QuotaExceed.ElasticQuotaNo additional quota is available for the specified ECS instance type.The error message returned because the maximum number of instances of the specified instance type in the region has been reached. You can try another region or instance type, or reduce the number of instances that you want to purchase. Alternatively, you can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type.The error message returned because the maximum number of instances of the specified instance type in the region has been reached. You can try another region or instance type, or reduce the number of instances that you want to purchase. Alternatively, you can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.The error message returned because the maximum number of vCPUs for all instance types has been reached in the zone. You can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type, or the number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.The error message returned because the maximum number of instances of the specified instance type in the region has been reached or because the maximum number of vCPUs for all instance types has been reached. You can go to the ECS console or Quota Center to request a quota increase.
403OperationDenied.HostRepairingThe specified operation is denied as the host of ECS instance is being repaired.The error message returned because the operation is not supported while the physical machine that hosts the ECS instance is being repaired.
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The error message returned because the specified InstanceId parameter does not exist.
500InternalErrorThe request processing has failed due to some unknown error.The error message returned because an internal error has occurred. Try again later.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.The error message returned because an internal error has occurred. Try again later.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The error message returned because the request has failed due to a temporary failure of the backend server.

For a list of error codes, see Service error codes.