この操作を呼び出して、ワークフローインスタンスを照会することができます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 ご参考までに、この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK に用意されているサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須 例 説明
Action String 必須 ListFlowInstance

実行する操作です。 値を ListFlowInstance に設定します。
ProjectId String 必須 FP-7A1018ADE9179EE1

プロジェクトの ID です。
RegionId String 必須 cn-hangzhou

プロジェクトが配置されているリージョンの ID です。
FlowId String 任意 F-1B4018ADE9179EE1

ワークフローの ID です。
FlowName String 任意 my_flow

ワークフローの名前です。
Id String 任意 x

このパラメーターは使用できません。
InstanceId String 任意 FI-7CAF9709CD328EBE

ワークフローインスタンスの ID です。
OrderBy String 任意 id

ワークフローインスタンスの順序付けに応じたフィールドです。
OrderType String 任意 asc

ワークフローインスタンスの順序付けに応じた方法です。 有効値: ASC と DESC です。
Owner String 任意 1230404****

ワークフローインスタンスの所有者 ID です。
PageNumber Integer 任意 1

返されるページ数です。
PageSize Integer 任意 20

返される各ページのエントリ数です。
StatusList.N RepeatList 任意 RUNNING

ワークフローインスタンスのステータスです。
TimeRange String 任意 {"type":"date","date":"ALL"}

ワークフローインスタンス照会の時間範囲です。

レスポンスパラメーター

パラメーター データ型 例 説明
FlowInstances

ワークフローインスタンスの一覧です。
FlowInstance

ワークフローインスタンスの情報です。
ClusterId String C-F32FB31D82954C64

クラスターの ID です。
Duration Long 12000

ワークフローインスタンスの実行時間です。 単位: ミリ秒です。

EndTime Long 1540796248000

ワークフローインスタンスの実行が終了した時刻です。
FlowId String F-35683D0E45734E34

ワークフローの ID です。
FlowName String flow-hive

ワークフローの名前です。
GmtCreate Long 1540796248000

ワークフローの作成時刻です。
GmtModified Long 1540796248000

ワークフローの変更時刻です。
HasNodeFailed Boolean false

このパラメーターは使用できません。
Id String FI-7CAF9709CD328EBE

ワークフローインスタンスの ID です。
Owner String ****

ワークフローインスタンスの所有者 ID です。
ProjectId String FP-7A1018ADE9179EE1

プロジェクトの ID です。
StartTime Long 1540796236000

ワークフローインスタンスの実行が開始された時刻です。
Status String SUCCEEDED

ワークフローインスタンスのステータスです。 有効値:

  • PREP: ワークフローインスタンスは準備中です。
  • RUNNING: ワークフローインスタンスは実行中です。
  • SUCCEEDED: ワークフローインスタンスの実行に成功しました。
  • FAILED: ワークフローインスタンスの実行に失敗しました。
  • Terminated: ワークフローインスタンスは終了しました。
  • SUSPENDED: ワークフローインスタンスは一時停止されました。
PageNumber Integer 1

返されたページの数です。
PageSize Integer 20

返されるエントリの 1 ページあたりの数です。
RequestId String EDF99BA3-F7AF-49B2-ABA1-36430A31F482

リクエストの ID です。
Total Integer 42

返されたエントリの総数を示します。

例

リクエストの例


http(s)://[Endpoint]/? Action = ListFlowInstance
＆ProjectId = FP-7A1018ADE9179EE1
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式 

<ListFlowInstanceResponse>
{
    "FlowInstances"：{
        "FlowInstance"：[
            {
                "Status": "FAILED",
                "FlowId": "F-9C8D2BEC4D3803BC",
                "Owner": "1250460021754461",
                "GmtCreate": 1542963000000,
                "EndTime": 1542963033000,
                "ClusterId": "C-A6C9F4F1E9EC****",
                "FlowName": "success+fail",
                "StartTime": 1542963001000,
                "ProjectId": "FP-17AB3389E1AD9A34",
                "GmtModified": 1542963033000,
                "Duration": 32000,
                "Id": "FI-03F019530CB8****"
            },
            {
                "Status": "SUCCEEDED",
                "FlowId": "F-FECA99A4AE794199",
                "Owner": "205389038983463961",
                "GmtCreate": 1542963000000,
                "EndTime": 1542963015000,
                "ClusterId": "C-A6C9F4F1E9EC****",
                "FlowName": "success",
                "StartTime": 1542963000000,
                "ProjectId": "FP-17AB3389E1AD9A34",
                "GmtModified": 1542963015000,
                "Duration": 15000,
                "Id": "FI-60B9DBFA5AD2****"
            }
        ]
    },
    "PageSize": 2,
    "RequestId": "780BB15A-9038-4330-BE6C-0A47FE5A1BBF",
    "PageNumber": 1,
    "Total": 50
}
</ListFlowInstanceResponse>

JSON 形式 

{
	"FlowInstances":{
		"FlowInstance":[
			{
				"Owner":"1250460021754461",
				"Status":"FAILED",
				"ClusterId":"C-A6C9F4F1E9EC****",
				"FlowName":"success+fail",
				"Duration":32000,
				"FlowId":"F-9C8D2BEC4D3803BC",
				"Id":"FI-03F019530CB8****",
				"EndTime":1542963033000,
				"StartTime":1542963001000,
				"GmtCreate":1542963000000,
				"GmtModified":1542963033000,
				"ProjectId":"FP-17AB3389E1AD9A34"
			},
			{
				"Owner":"205389038983463961",
				"Status":"SUCCEEDED",
				"ClusterId":"C-A6C9F4F1E9EC****",
				"FlowName":"success",
				"Duration":15000,
				"FlowId":"F-FECA99A4AE794199",
				"Id":"FI-60B9DBFA5AD2****",
				"EndTime":1542963015000,
				"StartTime":1542963000000,
				"GmtCreate":1542963000000,
				"GmtModified":1542963015000,
				"ProjectId":"FP-17AB3389E1AD9A34"
			}
		]
	},
	"PageNumber":1,
	"PageSize":2,
	"RequestId":"780BB15A-9038-4330-BE6C-0A47FE5A1BBF",
	"Total":50
}

エラーコード

エラーコードの一覧については、「API エラーセンター」をご参照ください。