全部產品
Search

搜尋本產品

    Elastic Compute Service：DescribeTasks - 查詢工作清單

    文件中心

    Elastic Compute Service：DescribeTasks - 查詢工作清單

    更新時間：Apr 04, 2026

    調用DescribeTasks查詢一個或多個非同步請求的進度。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ecs:DescribeTasks

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PageNumber

    integer

    否

    查詢結果的頁碼。

    起始值：1。

    預設值：1。

    1
    PageSize

    integer

    否

    分頁查詢時設定的每頁記錄數。

    最大值：100。

    預設值：10。

    10
    RegionId

    string

    是

    地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

    cn-hangzhou
    TaskIds

    string

    否

    任務 ID。單次最多支援指定 100 個，ID 之間使用半形逗號（,）分隔。

    t-bp1hvgwromzv32iq****,t-bp179lofu2pv768w****
    TaskAction

    string

    否

    任務操作的介面名稱。取值範圍：

    • ImportImage：匯入鏡像。

    • ExportImage：匯出鏡像。

    • RedeployInstance：重新部署 ECS 執行個體。

    • ModifyDiskSpec：變更雲端硬碟類型。

    • ArchiveSnapshot ：歸檔快照。

    ImportImage
    TaskStatus

    string

    否

    任務狀態。取值範圍：

    • Finished：已完成。

    • Processing：運行中。

    • Failed：失敗。

    預設值：無。

    說明

    只支援查詢狀態為 Finished、Processing 和 Failed 的任務，填入其他取值將不會生效。

    Finished
    StartTime

    string

    否

    按建立時間查詢，建立時間區間的起始點。按照ISO 8601標準表示，並需要使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2020-11-23T15:10:00Z
    EndTime

    string

    否

    按建立時間查詢，建立時間區間的終止點。按照ISO 8601標準表示，並需要使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2020-11-23T15:16:00Z
    ResourceIds

    array

    否

    資源 ID。N 的取值範圍：1~100。

    string

    否

    任務關聯的資源 ID。N 的取值範圍：1~100。

    • 當 TaskAction 為 ImportImage、ExportImage 時，資源 ID 為鏡像 ID。

    • 當 TaskAction 為 RedeployInstance 時，資源 ID 為 ECS 執行個體 ID。

    • 當 TaskAction 為 ModifyDiskSpec 時，資源 ID 為磁碟 ID。

    m-bp1i8huqm5u7****
    TaskGroupId

    string

    否

    工作群組 ID。

    說明

    該參數正在邀測中，當使用該參數時，其它查詢條件將失效。

    g-2ze2op2grqpclwu7****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageSize

    integer

    當前分頁包含多少條目。

    10
    PageNumber

    integer

    分頁查詢的當前頁碼。

    1
    RequestId

    string

    請求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    TotalCount

    integer

    返回結果的總條目數。

    1
    RegionId

    string

    地區 ID。

    cn-hangzhou
    TaskSet

    object

    Task

    array<object>

    任務集合。

    object

    CreationTime

    string

    建立時間。

    2020-11-24T12:50Z
    TaskStatus

    string

    任務狀態。

    Finished
    FinishedTime

    string

    結束時間。

    2020-11-24T12:50Z
    SupportCancel

    string

    是否支援取消任務。

    true
    TaskId

    string

    任務 ID。

    t-bp1hvgwromzv32iq****
    TaskAction

    string

    任務名稱。

    ImportImage
    ResourceId

    string

    資源 ID。

    m-bp1i8huqm5u7****

    樣本

    正常返回樣本

    JSON格式

    {
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "RegionId": "cn-hangzhou",
  "TaskSet": {
    "Task": [
      {
        "CreationTime": "2020-11-24T12:50Z",
        "TaskStatus": "Finished",
        "FinishedTime": "2020-11-24T12:50Z",
        "SupportCancel": "true",
        "TaskId": "t-bp1hvgwromzv32iq****",
        "TaskAction": "ImportImage",
        "ResourceId": "m-bp1i8huqm5u7****"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 MissingParameter An input parameter "RegionId" that is mandatory for processing the request is not supplied.
    400 InvalidRegionId.NotFound The specified RegionId does not exist.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。