ListAsyncTasks - 擷取非同步工作清單 -

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

fc:ListAsyncTasks

list

*全部資源

*

無

請求文法

GET /2023-03-30/functions/{functionName}/async-tasks HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
functionName	string	是	函數名稱。	my-func

請求參數

名稱	類型	必填	描述	樣本值
prefix	string	否	非同步任務 ID 首碼，指定後會返回符合首碼的非同步工作清單。	job-
nextToken	string	否	分頁標記，用來返回更多結果。第一次查詢不需要提供這個參數，後續查詢的 Token 從返回結果中擷取。	MTIzNCNhYmM=
limit	integer	否	返回非同步任務的數量。預設返回 20 個，取值範圍[1,100]。	10
qualifier	string	否	函數版本或別名。	LATEST
status	string	否	非同步任務執行狀態。 Enqueued：非同步訊息已入隊，等待處理。 Dequeued：非同步訊息已出隊，等待觸發。 Running：調用執行中。 Succeeded：調用執行成功。 Failed：調用執行失敗。 Stopped：調用執行終止。 Stopping：執行停止中。 Expired：您為任務配置了最長排隊等待的期限。該任務因為超期被丟棄（任務未被執行）。 Invalid：您的執行因函數被刪除等原因處於無效狀態（任務未被執行）。 Retrying：非同步呼叫因執行錯誤重試中。	Running
startedTimeBegin	integer	否	非同步任務啟動時間段的開始時間。	1640966400000
startedTimeEnd	integer	否	非同步任務啟動時間段的結束時間。	1640966400000
sortOrderByTime	string	否	返回非同步工作清單的排序方式。 asc 表示升序 desc 表示降序	asc
includePayload	boolean	否	是否返回非同步任務的入參。 true：當該參數設定為 true 時，非同步任務的列表將返回`invocationPayload`欄位。 false：當該參數設定為 false 時，則不返回`invocationPayload`欄位。說明 `invocationPayload`欄位表示非同步任務函數運行時的輸入參數。	true

返回參數

名稱	類型	描述	樣本值
	ListAsyncTaskOutput	返回資料結構體

樣本

正常返回樣本

JSON格式

{
  "nextToken": "MTIzNCNhYmM=\n",
  "tasks": [
    {
      "alreadyRetriedTimes": 3,
      "destinationStatus": "Succeeded",
      "durationMs": 1000,
      "endTime": 1633449590000,
      "events": [
        {
          "eventDetail": "body",
          "eventId": 1,
          "status": "Succeeded",
          "timestamp": 1647420449721
        }
      ],
      "functionArn": "acs:fc:cn-shanghai:1234/functions/my-func",
      "instanceId": "D4-*******9FD1-882707E",
      "qualifier": "prod",
      "requestId": "e026ae92-61e5-472f-b32d-1c9e3c4e****",
      "returnPayload": "result",
      "startedTime": 1633449590000,
      "status": "Running",
      "taskErrorMessage": "UnhandledInvocationError",
      "taskId": "e026ae92-61e5-472f-b32d-1c9e3c4e****",
      "taskPayload": "body"
    }
  ]
}

錯誤碼

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

變更歷史

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