本接口用于啟動一臺ECS實例,您可以通過指定實例ID以及按需設置 InitLocalDisk 等參數啟動實例。
接口說明
該接口為異步接口,實例的啟動不是立即完成的,成功調用后,實例會先進入啟動中(Starting)狀態,你可以調用 DescribeInstanceStatus 查看實例狀態,當返回的狀態為Running
時代表啟動成功。
使用須知
- 被安全鎖定的實例不能通過調用該接口啟動。更多信息,請參見資源安全鎖定對調用 API 的影響。
- ECS 實例狀態必須為已停止(
Stopped
)。 - 節省停機模式下可能會因為庫存不足導致啟動失敗。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:StartInstance | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 指定啟動的實例 ID。 | i-bp67acfmxazb4p**** |
InitLocalDisk | boolean | 否 | 當本地盤出現故障時,可通過此參數指定啟動實例時,是否將實例恢復到最初的健康狀態。適用于實例規格族 d1、i1 或者 i2 等包含本地盤的實例。取值范圍:
默認值為 false。 | true |
DryRun | boolean | 否 | 是否只預檢查此次請求。取值范圍:
默認值為 false。 | true |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
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 | InvalidDedicatedHost.NotEnoughResource | There's no available dedicated host to perform the operation. | - |
400 | InvalidInstance.NotFoundSystemDisk | The specified instance does not have system disk. | - |
400 | Invalid.PrivatePoolOptions.NoStock | The PrivatePool has been used up. | - |
403 | InvalidParameter.KMSKeyId.NotFound | The specified KMSKeyId does not exist. | 指定的參數 KMSKeyId 不存在。 |
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. | 按量付費的實例已過期。請確保您的阿里云賬號有足夠的余額。 |
403 | InstanceExpired | The prePaid instance has been expired. | 當前實例已過期,不支持查詢變配價格。 |
403 | InstanceNotReady | The specified instance is not ready for use. | 該資源目前的狀態不支持此操作,請您等待一段時間再進行操作,并確認實例目前狀態與操作是否沖突。 |
403 | DiskInArrears | The specified operation is denied as your disk has expired. | 磁盤欠費過期。 |
403 | OperationDenied.NoStock | The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. | 庫存不足。 |
403 | OperationDenied.SpotPriceLowerThanPublicPrice | The spot instance price is lower than public price. | 搶占式實例的競價價格不能低于公開的價格。 |
403 | IncorrectInstanceStatus | %s | 當前實例的狀態不支持此操作。 |
403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | CMK 未授權 |
403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設置了 KMSKeyId 后,CMK必須處于啟用狀態。您可以調用密鑰管理服務的 DescribeKey 接口查詢指定CMK的相關信息。 |
403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服務無權訪問您的 KMS。 |
403 | QuotaExceed.ElasticQuota | No additional quota is available for the specified ECS instance type. | 您在當前地域選擇的實例規格所要創建的臺數超出系統限額,您可以選擇其他地域、實例規格或減少臺數重新購買,也可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | QuotaExceed.ElasticQuota | The number of the specified ECS instances has exceeded the quota of the specified instance type. | 您在當前地域選擇的實例規格所要創建的臺數超出系統限額,您可以選擇其他地域、實例規格或減少臺數重新購買,也可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | QuotaExceed.ElasticQuota | The number of vCPUs assigned to the ECS instances has exceeded the quota in the zone. | 您的全實例規格vCPU配額超出系統限額,您可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | QuotaExceed.ElasticQuota | The 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. | 您在當前地域選擇的實例規格所要創建的臺數超出系統限額,或者全實例規格vCPU配額超出系統限額,您可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | OperationDenied.HostRepairing | The specified operation is denied as the host of ECS instance is being repaired. | ECS實例所在物理機正在維修中不允許執行指定操作。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
404 | InvalidCapacityReservationId.NotFound | The specified capacity reservation does not exist. | - |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤,請重試。 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 請求后端超時,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |