この操作を呼び出して、ジョブインスタンスを照会できます。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 必須 ListFlowJobHistory

実行する操作。 値を ListFlowJobHistory に設定します。
ProjectId String 必須 FP-257A173659F59685

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

プロジェクトが配置されているリージョンの ID。
Id String 任意 FJ-BCCAE48B90CCB37B

ジョブの ID。
InstanceId String 任意 FJI-BCCAE48B90CCB37B

ジョブインスタンスの ID。
JobType String 任意 SHELL

ジョブの種類。
PageNumber Integer 任意 1

返されるページのページ番号。
PageSize Integer 任意 20

返される各ページのエントリ数。
StatusList.N RepeatList 任意 ["FAILED"]

ジョブインスタンスのステータス。 有効な値：

  • FAILED
  • KILLED
  • KILL_FAILED
  • PREP
  • SUBMITTING
  • RUNNING
  • START_RETRY
  • OK
  • DONE
  • TIMEOUT
TimeRange String 任意 {"type":"range","from":1564416000000,"to":1567008000000}

ジョブインスタンスを照会する時間範囲。

レスポンスパラメーター

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

ノードインスタンスのリスト。
NodeInstance

ジョブインスタンスの情報。
ClusterId String C-A6C9F4F1E9EC88D9

クラスターの ID。
EndTime Long 1540796248000

ジョブインスタンスの実行が終了した時刻。
EnvConf String {"key":"value"}

ジョブ用に設定された環境変数。
ExternalId String application_1541559535023_34027

ランチャーアプリケーションの ID。

ExternalInfo String empty

ジョブインスタンスの外部情報 (ジョブインスタンスのエラー診断情報など)。
ExternalStatus String SUCCESS

ジョブインスタンスの外部ステータス。 有効な値：

  • SUBMITTED：ジョブインスタンスが送信済み。
  • RUNNING：ジョブインスタンスが実行中。
  • SUCCESS：ジョブインスタンスの実行に成功。
  • FAIL：ジョブインスタンスの実行に失敗。
  • KILL_FAIL：ジョブインスタンスの強制終了に失敗。
  • KILL_SUCCESS：ジョブインスタンスの強制終了に成功。
FailAct String STOP

ノードインスタンスの操作に失敗したときに実行する操作。 有効な値：

  • STOP：ワークフローインスタンスを停止。 CONTINUE：ノードインスタンスをスキップ。
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 Integer 0

障害が発生したときにノードインスタンスの実行を再試行する最大回数。
NodeName String Empty

ノード名。
ParamConf String {"date":"${yyyy-MM-dd}"}

ジョブの設定パラメーター。
ProjectId String FP-3535FE0BE5224A47

プロジェクトの ID。
Retries Integer 0

ノードインスタンスの実行を再試行する回数。
RetryInterval Long 200

ノードインスタンスの実行を連続して再試行する時の時間間隔。
RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

ジョブに設定されたスケジューリングパラメーター。

  • priority：ジョブの優先度。
  • userName：ジョブを送信した Linux ユーザーの名前。
  • memory：ジョブに割り当てられたメモリ。 単位：MB。
  • cores：ジョブに割り当てられた vCPU の数。
StartTime Long 1540796237000

ジョブインスタンスの実行が開始した時刻。
Status String OK

ジョブインスタンスのステータス。 有効な値：

  • PREP：ジョブインスタンスの準備中。
  • SUBMITTING：ジョブインスタンスの送信中。
  • RUNNING：ジョブインスタンスの実行中。
  • DONE：ジョブインスタンスの実行を完了。
  • OK：ジョブインスタンスの実行に成功。
  • FAIL：ジョブインスタンスの実行に失敗。
  • KILLED：ジョブインスタンスの強制終了に成功。
  • KILL_FAIL：ジョブインスタンスの強制終了に失敗。
  • START_RETRY：ジョブインスタンスの再起動中。
Type String JOB

ノードの種類。 有効な値：

  • JOB：ジョブノード
  • CLUSTER：クラスターノード
  • START：開始ノード
  • END：終了ノード
pending Boolean false

ジョブインスタンスの実行が終了したかどうかを示します。
PageNumber Integer 1

返されたページのページ番号。
PageSize Integer 20

返された 1 ページあたりのエントリ数。
RequestId String F5540D8F-06E8-4E3C-B47A-D75CED72A795

リクエストの ID。
Total Integer 12

返されたエントリの総数。

例

リクエストの例


http(s)://[Endpoint]/? Action=ListFlowJobHistory
&Id=FJ-BCCAE48B90CCB37B
&ProjectId=FP-257A173659F59685
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<ListFlowJobHistoryResponse>
  <PageSize>10</PageSize>
	  <RequestId>BCF52B64-007F-4883-BAEA-0499106D07C2</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>1</Total>
	  <NodeInstances>
		    <NodeInstance>
			      <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-F4FC53D7207E****</Id>
			      <HostName>emr-header-2.cluster-50016****</HostName>
			      <JobId>FJ-31BD66C7BC502815</JobId>
		    </NodeInstance>
	  </NodeInstances>
	

</ListFlowJobHistoryResponse>

JSON 形式 

{
	"PageNumber":1,
	"PageSize":10,
	"NodeInstances":{
		"NodeInstance":[
			{
				"FailAct":"STOP",
				"Retries":0,
				"ExternalId":"application_1542955685866_0003",
				"JobName":"success",
				"GmtCreate":1542957499000,
				"GmtModified":1542957514000,
				"HostName":"emr-header-2.cluster-50016****",
				"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-F4FC53D7207E****",
				"EndTime":1542957514000,
				"ExternalInfo":"",
				"StartTime":1542957499000,
				"ExternalStatus":"SUCCESS",
				"ProjectId":"FP-17AB3389E1AD9A34"
			}
		]
	},
	"RequestId":"BCF52B64-007F-4883-BAEA-0499106D07C2",
	"Total":1
}

エラーコード

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