ListStatefulAsyncInvocations - Function Compute - Alibaba Cloud ドキュメントセンター

特定の条件を満たす非同期タスクをクエリします。

StatefulAsyncInvocationは非同期タスクを表します。非同期タスク (StatefulAsyncInvocation) を使用すると、非同期呼び出しの状態を管理できます。非同期タスク機能は、タスクシナリオに適しています。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみが使用されます。詳細は、共通パラメータを参照してください。

リクエスト構文

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

リクエストパラメーター

パラメーター	データ型	位置	必須	例	説明
serviceName	String	パス	あり	service_name	非同期タスクが属するサービスの名前。
functionName	String	パス	あり	function_name	非同期タスクを照会する関数の名前。
修飾子	String	パス	なし	alias	非同期タスクが属するサービスのバージョンまたはエイリアス。
invocationIdPrefix	String	パス	なし	仕事-***	非同期タスクの名前のプレフィックス。このパラメーターは、返される非同期タスクの名前を制限するために使用されます。たとえば、`invocationidPrefix`パラメーターを`job`に設定した場合、返される呼び出しの名前は`job`で始まる必要があります。
nextToken	String	クエリ	あり	e026ae92-61e5-472f-b32d-1c9e3c4e ****	非同期タスクをクエリするときに開始位置を指定するために使用されるトークン。最初のクエリでこのパラメーターを指定する必要はありません。呼び出し回数が制限を超えると、nextTokenパラメーターが返されます。この値を以降の呼び出しで使用して、より多くの結果を取得できます。
limit	Integer	クエリ	なし	50	返す非同期タスクの最大数。有効な値: [1,100] 。デフォルト値は 50 です。
startedTimeBegin	Long	クエリ	なし	161941846 ****	非同期タスクが開始される時間範囲の開始。単位：ミリ秒。
startedTimeEnd	Long	クエリ	なし	161941846 ****	非同期タスクが開始される時間範囲の終了。単位：ミリ秒。
sortOrderByTime	String	クエリ	なし	asc	返された非同期タスクを並べ替えるために使用するメソッド。有効な値： asc: 昇順 desc: 降順
includePayload	Boolean	クエリ	なし	true	レスポンスでinvocationPayloadパラメーターを返すかどうかを指定します。 true: レスポンスで`invocationPayload`パラメーターを返します。 false: レスポンスで`invocationPayload`パラメーターを返しません。説明 `invocationPayload`パラメーターは、非同期タスクの入力パラメーターを示します。

レスポンスパラメーター

パラメーター	データ型	例	説明
呼び出し	配列		非同期タスクのリスト。
startedTime	Long	202008-20T02: 28:21Z	非同期タスクの開始時刻。
endTime	Long	202008-20T02: 38:21Z	非同期タスクの終了時刻。
functionName	String	function_name	非同期タスクを照会する関数の名前。
修飾子	String	alias	非同期タスクが属するサービスのバージョンまたはエイリアス。
serviceName	String	service_name	非同期タスクが属するサービスの名前。
invocationId	String	e026ae92-61e5-472f-b32d-1c9e3c4e ****	非同期タスクID。
requestId	String	403fcbd6-ec41-401f-9fa7-386f3d3d ****	非同期タスクのリクエストID。
status	String	成功	非同期タスクの状態。 Enqueued: 非同期呼び出しはエンキューされ、実行待ちです。 Dequeued: 非同期呼び出しがデキューされ、トリガーされるのを待っています。 Running: 呼び出しは実行中です。 Succeeded: 呼び出しが成功しました。失敗: 呼び出しが失敗します。 Stopped: 呼び出しが終了しました。 Stopping: 呼び出しは終了中です。期限切れ: 非同期呼び出しの有効期間が設定されています。呼び出しが期限切れになり、破棄されました。無効: タスクは無効で、特定の理由でトリガーされません。たとえば、関数が削除されました。リトライ中: 実行エラーのため、非同期呼び出しがリトライ中です。
destinationStatus	String	成功	非同期タスクの宛先ステータス。
invocationErrorMessage	String	UnhandledInvocationError	非同期タスクに対して返されるエラーメッセージ。
InvocationPayload	String	Hello World	非同期タスクによってトリガーされるイベント。
alreadyRetriedTimes	Long	3	非同期タスクが失敗した後に許可される再試行の最大数。デフォルト値: 3。有効な値: [0,8] 。
nextToken	String	caeba0be03 **** f84eb48b699f0a4883	より多くの結果を得るために使用されるトークン。非同期タスクの数が制限を超えると、nextTokenパラメーターが返されます。より多くの結果を取得するには、後続の呼び出しにこのパラメーターを含める必要があります。最初の呼び出しでこのパラメーターを指定する必要はありません。

例

リクエストの例

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
Common request header

正常に処理された場合のレスポンス例

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"
}

HTTP ステータスコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。