ジョブをクエリする操作です。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須項目 例 説明
Action String はい ListFlowJob

実行したい操作。 値を ListFlowJob に設定します。
ProjectId String はい FP-257A173659F5 ****

プロジェクトの ID。
RegionId String はい cn-hangzhou

プロジェクトが配置されているリージョンの ID。
Adhoc Boolean いいえ false

ジョブが一時クエリジョブかどうかを示します。
Id String いいえ FJ-BCCAE48B90CCB37B

ジョブの ID。
Name String いいえ my_shell_job

ジョブの名前。
PageNumber Integer いいえ 1

返されるページ数。
PageSize Integer いいえ 20

返される各ページのエントリ数。
Type String いいえ SHELL

ジョブのタイプ。 有効値: MR、SPARK、HIVE_SQL、HIVE、PIG、SQOOP、SPARK_SQL、SPARK_STREAMING、SHELL。

レスポンスパラメーター

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

ジョブのリスト。
Job

ジョブの情報。
Adhoc String false

ジョブが一時クエリジョブかどうかを示します。
AlertConf String "{\"items\":[{\"enable\":true,\"eventId\":\"EMR-210401001\",\"alertUserGroupIdList\":[\"AUG-52dabfbbca654b52aae05ac5acd9a0f0\"],\"alertDingDingGroupList\":[\"ADG-2c411c452e6b467b9a59fadf21d195ad\"]}]}"

ジョブインスタンスのアラート設定。
CategoryId String FC-5BD9575E34623940

ジョブのディレクトリ ID。
CustomVariables String "{\"scope\":\"PROJECT\",\"entityId\":\"FP-80C2FDDBF35D9CC5\",\"variables\":[{\"name\":\"v1\",\"value\":\"1\",\"properties\":{\"password\":true}}]}"

ジョブ用に設定されたカスタム変数。
Description String This is the description of a job

ジョブの説明
EnvConf String {"key":"value"}

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

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

  • CONTINUE: ノードのインスタンスをスキップ
  • STOP: ワークフローインスタンスを停止
GmtCreate Long 1538017814000

ジョブの作成時間。
GmtModified Long 1538017814000

ジョブの変更時間。
Id String FJ-BCCAE48B90CCB37B

ジョブの ID。
LastInstanceDetail String ""

このパラメーターは使用できません。
MaxRetry Integer 5

障害が発生したときにノードインスタンスの実行を再試行する最大回数。
MonitorConf String {"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}

ジョブの監視設定。 このパラメーターは、 SPARK_STREAMING ジョブのみに適用されます。

Name String my_shell_job

ジョブの名前。
ParamConf String {"date":"${yyyy-MM-dd}"}

ジョブの設定パラメーター。
Params String ls -l

ジョブの内容。
ResourceList

ジョブ用に設定されたリソース。
Resource

ジョブ用に構成されたリソース。
Alias String demo.jar

リソースのエイリアス。
Path String oss://path/demo.jar

リソースのストレージパス。
RetryInterval Long 200

ノードインスタンスの実行を再試行する間隔。 有効値：0~300。 単位: 秒。
RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

ジョブに設定されたスケジュールパラメーター。
Type String SHELL

ジョブのタイプ。 有効値: MR、SPARK、HIVE_SQL、HIVE、PIG、SQOOP、SPARK_SQL、SPARK_STREAMING、SHELL。
mode String YARN

ジョブの送信モード。 有効値: YARN と LOCAL。
PageNumber Integer 1

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

ページごとの返されるエントリ数。
RequestId String 7D2B1B2E-8D89-49C1-8D31-097C83879D20

リクエストの ID。
Total Integer 11

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

例

リクエスト例


http(s)://[Endpoint]/? Action=ListFlowJob
&ProjectId=FP-257A173659F5****
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式 

<ListFlowJobResponse>
  <PageSize>2</PageSize>
	  <RequestId>B83F5335-C8BF-47E9-9DE2-AC1C5E1B3D39</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>6</Total>
	  <JobList>
		    <Job>
			      <FailAct>STOP</FailAct>
			      <CategoryId>FC-BF013F34DE395AFC</CategoryId>
			      <Description>success</Description>
			      <GmtModified>1542957519000</GmtModified>
			      <Params>
				sleep 10;
			exit 0;</Params>
			      <MaxRetry>0</MaxRetry>
			      <Name>success</Name>
			      <ResourceList></ResourceList>
			      <Type>SHELL</Type>
			      <GmtCreate>1542957478000</GmtCreate>
			      <Adhoc>false</Adhoc>
			      <RetryInterval>15</RetryInterval>
			      <Id>FJ-31BD66C7BC50****</Id>
		    </Job>
		    <Job>
			      <FailAct>STOP</FailAct>
			      <CategoryId>FC-54C10B119442DC0C</CategoryId>
			      <Description>fail</Description>
			      <GmtModified>1542958715000</GmtModified>
			      <Params>
				sleep 10;
			exit 1;</Params>
			      <MaxRetry>0</MaxRetry>
			      <Name>fail</Name>
			      <ResourceList></ResourceList>
			      <Type>SHELL</Type>
			      <GmtCreate>1542957560000</GmtCreate>
			      <Adhoc>false</Adhoc>
			      <RetryInterval>15</RetryInterval>
			      <Id>FJ-A200F16108CA****7</Id>
		    </Job>
	  </JobList>
	

</ListFlowJobResponse>

JSON 形式 

{
	"PageNumber":1,
	"JobList":{
		"Job":[
			{
				"FailAct":"STOP",
				"Description":"success",
				"Type":"SHELL",
				"GmtCreate":1542957478000,
				"GmtModified":1542957519000,
				"Name":"success",
				"MaxRetry":0,
				"CategoryId":"FC-BF013F34DE395AFC",
				"RetryInterval":15,
				"ResourceList":{
					"Resource":[]
				},
				"Params":"sleep 10;\nexit 0;",
				"Id":"FJ-31BD66C7BC50****",
				"Adhoc":false
			},
			{
				"FailAct":"STOP",
				"Description":"",
				"Type":"SHELL",
				"GmtCreate":1542957560000,
				"GmtModified":1542958715000,
				"Name":"fail",
				"MaxRetry":0,
				"CategoryId":"FC-54C10B119442DC0C",
				"RetryInterval":15,
				"ResourceList":{
					"Resource":[
				},
				"Params":"sleep 10;\nexit 1;",
				"Id":"FJ-A200F16108CA****",
				"Adhoc":false
			}
		]
	},
	"PageSize":2,
	"RequestId":"B83F5335-C8BF-47E9-9DE2-AC1C5E1B3D39",
	"Total":6
}

エラーコード

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