StartInstance

更新时间:
复制 MD 格式

Starts an Elastic Compute Service (ECS) instance. You can specify the ID of an ECS instance and parameters, such as InitLocalDisk, in the request based on your business requirements to start the instance.

Operation description

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

Precautions

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

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

  • If an ECS instance is stopped in economical mode, the instance 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:StartInstance

update

*Instance

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

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The ID of the instance that you want to start.

i-bp67acfmxazb4p****

InitLocalDisk

boolean

No

Specifies whether to restore the ECS instance to the initial health state on startup if a local disk fails. This parameter is applicable to ECS instances that are equipped with local disks, such as d1, i1, and i2 instances. Valid values:

  • true: restores the ECS instance to the initial health state on startup.

    **

    Warning: After the ECS instance is restored to the initial health state, data stored on the local disks of the instance is lost.

  • false: does not restore the ECS instance to the initial health state on startup. The instance remains in the current state.

Default value: false.

true

DryRun

boolean

No

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the 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 performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

Default value: false.

true

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

Error response

JSON format

{
    "RequestId": "C0003E8B-B930-4F59-ADC0-0E20xxxxxxxx"
}

Error codes

HTTP status code

Error code

Error message

Description

400 LackResource There's no enough resource on the specified capacity reservation.
400 InvalidDedicatedHost.NotEnoughResource The specified dedicated host has not enough resource due to host affinity.
400 InvalidInstance.NotFoundSystemDisk The specified instance does not have system disk.
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 InstanceNotReady The specified instance is not ready for use.
500 InternalError The request processing has failed due to some unknown error.
403 InvalidParameter.KMSKeyId.NotFound The specified KMSKeyId does not exist.
403 IncorrectInstanceStatus The current status of the resource does not support this operation.
403 InstanceLockedForSecurity The specified operation is denied as your instance is locked for security reasons.
403 InsufficientBalance Your account does not have enough balance.
403 DiskError IncorrectDiskStatus.
403 InstanceExpired The postPaid instance has been expired.Please ensure your account have enough balance. The pay-as-you-go instance has expired. Make sure that your Alibaba Cloud account balance is sufficient.
403 InstanceNotReady The specified instance is not ready for use.
403 DiskInArrears The specified operation is denied as your disk has expired.
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 InvalidParameter.KMSKeyId.CMKUnauthorized The CMK needs to be added ECS tag.
403 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK needs to be enabled.
403 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service have no right to access your KMS. ECS is not authorized to access your KMS resources.
403 QuotaExceed.ElasticQuota No additional quota is available for the specified ECS instance type. The maximum number of instances of the specified instance type in the region has been reached. Reduce the quantity of instances that you want to purchase or try another region or instance type. Alternatively, you can go to the ECS console or Quota Center to request a quota increase.
403 OperationDenied.HostRepairing The specified operation is denied as the host of ECS instance is being repaired. The operation is not supported while the physical machine that hosts the ECS instance is being repaired.
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 The specified InstanceId does not exist. The specified instanceId is invalid.
404 InvalidCapacityReservationId.NotFound The specified capacity reservation does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server.
503 LimitedOperation.ServiceUnavailable The service is currently unavailable. Please try again later. The service is currently unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.