ListFlowNodeInstance - - Alibaba Cloud ドキュメントセンター

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK のサンプルコードを動的に生成します。

リクエストパラメーター


パラメーター	データ型	必須項目	例	説明
Action	String	必須	ListFlowNodeInstance	実行したい操作。値を ListFlowNodeInstance に設定します。
RegionId	String	必須	cn-hangzhou	プロジェクトが属するリージョンの ID。
OrderBy	String	任意	start_time	ノードインスタンスがオーダーされるフィールド。
OrderType	String	任意	desc	ノードワークフローインスタンスをソート方法。
PageNumber	Integer	任意	1	返されるページ数。
PageSize	Integer	任意	20	返される各ページのエントリ数。
ProjectId	String	任意	FP-257A173659F5****	プロジェクトの ID。
StartTime	Long	任意	1540796248000	ノードインスタンスのクエリの開始時間。
StatusList.N	RepeatList	任意	FAILED	ノードインスタンスのステータス。

レスポンスパラメーター


パラメーター	データ型	例	説明
FlowNodeInstances	-	-	ノードインスタンスのリスト。
FlowNodeInstance	-	-	ノードインスタンスの情報。
ClusterId	String	C-A6C9F4F1E9E****	クラスターの ID。
Duration	Long	200	ノードインスタンスの実行期間。
EndTime	Long	1540796248000	ノードインスタスが停止した時間。
ExternalChildIds	String	application_1541559535023_34028	アプリケーションの ID。
ExternalId	String	application_1541559535023_34027	ランチャーアプリケーションの ID。
ExternalInfo	String	empty	エラー診断情報など、ノードインスタンスの外部情報。
ExternalStatus	String	SUCCESS	ノードインスタンスの外部ステータス。有効値は以下になります。 SUBMITTED: ノードインスタンスが送信されました。 RUNNING: ノードインスタンスは実行中です。 SUCCESS: ノードインスタンスの実行に成功しました。 FAIL: ノードインスタンスの実行に失敗しました。 KILL_FAIL: ノードインスタンスの終了に失敗しました。 KILL_SUCCESS: ノードインスタンスの終了に成功しました。
ExternalSubId	String	container_1541559535023_34027_01_000001	ランチャーコンテナの ID。
FailAct	String	STOP	ノードインスタンスが失敗した場合に実行する操作。有効値は以下になります。 STOP：ワークフローインスタンスを停止します。 CONTINUE：ノードインスタンスをスキップします。
FlowId	String	F-35683D0E45734E34	ワークフローの ID。
FlowInstanceId	String	FI-7CAF9709CD328EBE	ワークフローインスタンスの ID。
GmtCreate	Long	1540796236000	ワークフローの作成時間。
GmtModified	Long	1540796247000	ワークフローの変更時間。
HostName	String	emr-header-1.cluster-12345	ノードインスタンスが実行されているホストの名前。ホストはマスターホストまたはゲートウェイホストです。ホスト名の形式は emr-header-1.cluster-12345 です。 hostname コマンドを実行すると、このパラメーターの値を確認することができます。
Id	String	FNI-9D14A7CCF2687B84	ノードインスタンスの ID。
JobId	String	FJ-A23BD131A862F184	ジョブの ID。
JobName	String	myJob	ジョブの名前。
JobParams	String	ls -l	ジョブコンテンツ。
JobType	String	HIVE_SQL	ジョブタイプ。
MaxRetry	String	0	障害が発生した場合、ノードインスタンスの実行の最大再試行回数。
NodeName	String	node	ノード名。
Pending	Boolean	false	ノードインスタンスの実行が終了したかどうかを示します。
ProjectId	String	FP-7A1018ADE917****	プロジェクトの ID。
Retries	Integer	0	ノードインスタンスの実行の再試行回数。
RetryInterval	String	200	ノードインスタンスの実行を連続して再試行する間隔。
StartTime	Long	1540796237000	ノードインスタンスの実行開始時間。
Status	String	OK	ノードインスタンスのステータス。有効値は以下になります。 PREP: ノードインスタンスを準備しています。 SUBMITTING: ノードインスタンスが送信されています。 RUNNING: ノードインスタンスは実行中です。 DONE: ノードインスタンスの実行が完了しました。 OK: ノードインスタンスの実行に成功しました。 FAILED: ノードインスタンスの実行に失敗しました。 KILLED: ノードインスタンスは終了しました。 KILL_FAILED: ノードインスタンスの終了に失敗しました。 START_RETRY: ノードインスタンスを再起動しています。
Type	String	JOB	ノードの種類。有効値。
PageNumber	Integer	1	返されたページの数。
PageSize	Integer	20	ページごとの返されるエントリ数。
RequestId	String	83B256D4-4E95-454B-AD08-799DF31D5556	リクエストの ID。
Total	Integer	12	返されたエントリの総数。

例

リクエスト例


http(s)://[Endpoint]/? Action=ListFlowNodeInstance
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<ListFlowNodeInstanceResponse>
  <PageSize>10</PageSize>
	  <RequestId>BCF52B64-007F-4883-BAEA-0499106D07C2</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>1</Total>
	  <FlowNodeInstances>
		    <FlowNodeInstance>
			      <FailAct>STOP</FailAct>
			      <Status>OK</Status>
			      <EndTime>1542957514000</EndTime>
			      <ClusterId>C-A6C9F4F1E9EC****</ClusterId>
			      <ExternalId>application_1542955685866_0003</ExternalId>
			      <pending>false</pending>
			      <JobName>success</JobName>
			      <GmtModified>1542957514000</GmtModified>
			      <StartTime>1542957499000</StartTime>
			      <ProjectId>FP-17AB3389E1AD9A34</ProjectId>
			      <MaxRetry>0</MaxRetry>
			      <ParamConf>{"cyctime":"2018-11-23 15:18:19"}</ParamConf>
			      <ExternalStatus>SUCCESS</ExternalStatus>
			      <GmtCreate>1542957499000</GmtCreate>
			      <JobType>SHELL</JobType>
			      <ExternalInfo></ExternalInfo>
			      <Retries>0</Retries>
			      <RetryInterval>0</RetryInterval>
			      <Id>FJI-F4FC53D7207E4BEF</Id>
			      <HostName>emr-header-2.cluster-500160670</HostName>
			      <JobId>FJ-31BD66C7BC502815</JobId>
		    </FlowNodeInstance>
	  </FlowNodeInstances>
	</ListFlowNodeInstanceResponse>

JSON 形式

{
	"PageNumber":1,
	"FlowNodeInstances":{
		"FlowNodeInstance":[
			{
				"FailAct":"STOP",
				"Retries":0,
				"ExternalId":"application_1542955685866_0003",
				"JobName":"success",
				"GmtCreate":1542957499000,
				"GmtModified":1542957514000,
				"HostName":"emr-header-2.cluster-500160670",
				"JobType":"SHELL",
				"Status":"OK",
				"MaxRetry":0,
				"RetryInterval":0,
				"ClusterId":"C-A6C9F4F1E9EC****",
				"JobId":"FJ-31BD66C7BC502815",
				"pending":false,
				"ParamConf":"{\"cyctime\":\"2018-11-23 15:18:19\"}",
				"Id":"FJI-F4FC53D7207E4BEF",
				"EndTime":1542957514000,
				"ExternalInfo":"",
				"StartTime":1542957499000,
				"ExternalStatus":"SUCCESS",
				"ProjectId":"FP-17AB3389E1AD9A34"
			}
		]
	},
	"PageSize":10,
	"RequestId":"BCF52B64-007F-4883-BAEA-0499106D07C2",
	"Total":1
}

エラーコード

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