ListStatefulAsyncInvocations - Function Compute

StatefulAsyncInvocation：非同步任務。非同步任務在普通的非同步呼叫基礎上增加了狀態管理的功能，更適用於各類任務情境。

調試

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

要求標頭

該介面無特殊要求標頭，關於公用要求標頭資訊，請參見公用參數。

請求文法

GET /services/{serviceName[.qualifier]}/functions/{functionName}/stateful-async-invocations HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
serviceName	String	Path	是	service_name	非同步任務所屬的服務的名稱。
functionName	String	Path	是	function_name	非同步任務所屬的函數的名稱。
qualifier	String	Path	否	alias	非同步任務所屬的服務的別名或版本。
invocationIdPrefix	String	Path	否	job-***	非同步呼叫首碼。限定返回的資源名稱，假設`invocationidPrefix`為`job`，則返回的資源名必須以`job`開頭。
nextToken	String	Query	是	e026ae92-61e5-472f-b32d-1c9e3c4e****	非同步任務的查詢起始過濾欄位。第一次查詢不需要提供這個參數，後續查詢的Token從返回結果中擷取。
limit	Integer	Query	否	50	非同步呼叫的返回個數。預設返回50個，取值範圍[1,100]。
startedTimeBegin	Long	Query	否	161941846****	非同步任務啟動時間及起始值的過濾欄位。單位：毫秒。
startedTimeEnd	Long	Query	否	161941846****	非同步任務啟動時間及結束值的過濾欄位。單位：毫秒。
sortOrderByTime	String	Query	否	asc	非同步呼叫的排序方式。 asc：正序。 desc：逆序。
includePayload	Boolean	Query	否	true	true：當該參數設定為`true`時，非同步任務的列表將返回`invocationPayload`欄位。 false：當該參數設定為`false`時，則不返回`invocationPayload`欄位。說明 `invocationPayload`欄位表示非同步任務函數運行時的輸入參數。

返回資料

名稱	類型	樣本值	描述
invocations	Array		非同步任務的列表。
startedTime	Long	2020-08-20T02:28:21Z	非同步任務的開始時間。
endTime	Long	2020-08-20T02:38:21Z	非同步任務的結束時間。
functionName	String	function_name	非同步任務所屬的函數的名稱。
qualifier	String	alias	非同步任務所屬的服務的別名或版本。
serviceName	String	service_name	非同步任務所屬的服務的名稱。
invocationId	String	e026ae92-61e5-472f-b32d-1c9e3c4e****	非同步任務ID。
requestId	String	403fcbd6-ec41-401f-9fa7-386f3d3d****	非同步任務的請求ID。
status	String	Succeeded	非同步任務的執行狀態。 Enqueued：非同步訊息已入隊，等待處理。 Dequeued：非同步訊息已出隊，等待觸發。 Running：調用執行中。 Succeeded：調用執行成功。 Failed：調用執行失敗。 Stopped：調用執行終止。 Stopping：執行停止中。 Expired：您給非同步訊息配置了存活有效期間，該訊息因到期已被丟棄（未觸發）。 Invalid：您的執行因函數被刪除等原因處於無效狀態（未觸發）。 Retrying：非同步呼叫因執行錯誤重試中。
destinationStatus	String	Succeeded	非同步任務的目的狀態。
invocationErrorMessage	String	UnhandledInvocationError	非同步任務的錯誤訊息。
InvocationPayload	String	hello world	非同步任務的任務觸發事件。
alreadyRetriedTimes	Long	3	非同步任務調用失敗後的最大重試次數，預設值為3。取值範圍[0,8]。
nextToken	String	caeba0be03****f84eb48b699f0a4883	用來返回更多結果。第一次查詢不需要提供這個參數，後續查詢所需使用的Token，從返回結果中擷取。

樣本

請求樣本

GET /services/{serviceName[.qualifier]}/functions/function_name/stateful-async-invocations?nextToken=e026ae92-61e5-472f-b32d-1c9e3c4e****&limit=50&sortOrderByTime=asc&includePayload=true HTTP/1.1
Host:fc-ram.aliyuncs.com
Content-Type:application/json
公用要求標頭

正常返回樣本

JSON格式

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

{
  "invocations" : [ {
    "functionName" : "function_name",
    "qualifier" : "alias",
    "serviceName" : "service_name",
    "invocationId" : "e026ae92-61e5-472f-b32d-1c9e3c4e****",
    "requestId" : "403fcbd6-ec41-401f-9fa7-386f3d3d****",
    "status" : "Succeeded",
    "destinationStatus" : "Succeeded",
    "invocationErrorMessage" : "UnhandledInvocationError",
    "InvocationPayload" : "hello world",
    "alreadyRetriedTimes" : 3
  } ],
  "nextToken" : "caeba0be03****f84eb48b699f0a4883"
}

錯誤碼

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