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

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer を使用すると、さまざまな SDK 向けにサンプルコードを動的に生成することができます。

リクエストパラメーター


パラメーター	データ型	必須項目	例	説明
Action	String	必須	DescribeFlowJob	実行する操作。値を DescribeFlowJob に設定します。
Id	String	必須	FJ-BCCAE48B90CCB37B	ジョブの ID。
ProjectId	String	必須	FP-257A173659F59685	プロジェクトの ID。
RegionId	String	必須	cn-hangzhou	プロジェクトが配置されているリージョンの ID。

レスポンスパラメーター


パラメーター	データ型	例	説明
Adhoc	String	true	ジョブが一時的なクエリジョブかどうかを示します。
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	CONTINUE	ノードインスタンスの操作が失敗したときに実行する操作。有効な値: CONTINUE: ノードインスタンスをスキップします。 STOP: ワークフローインスタンスを停止します。
GmtCreate	Long	1538017814000	ジョブの作成時刻。
GmtModified	Long	1538017814000	ジョブの変更時刻。
Id	String	FJ-BCCAE48B90CCB37B	ジョブの ID。
LastInstanceId	String	FJI-ACCAE48B90CCB37B	最後に実行されたジョブインスタンスの ID。
MaxRetry	Integer	5	ノードインスタンスの実行に失敗したときに再試行する最大回数。有効な値: 0~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	ジョブの内容。
RequestId	String	1549175a-6d14-4c8a-89f9-5e28300f6d7e	リクエストの ID。
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}	ジョブに設定されたスケジュールパラメーター。 priority: ジョブの優先度。 userName: ジョブを送信した Linux ユーザーの名前。 memory: ジョブに割り当てられたメモリ。単位: MB。 cores: ジョブに割り当てられた vCPU の数。
Type	String	SHELL	ジョブの種類。有効な値: MR、SPARK、HIVE_SQL、HIVE、PIG、SQOOP、SPARK_SQL、SPARK_STREAMING、 SHELL。
mode	String	YARN	ジョブの送信モード。有効な値: YARN および LOCAL。

例

リクエストの例


http(s)://[Endpoint]/? Action=DescribeFlowJob
&Id=FJ-BCCAE48B90CCB37B
&ProjectId=FP-257A173659F59685
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<DescribeFlowJobResponse>
  <FailAct>STOP</FailAct>
	  <CategoryId>FC-F2495319DA05CEE5</CategoryId>
	  <Description>shell</Description>
	  <RequestId>7D2B1B2E-8D89-49C1-8D31-097C83879D20</RequestId>
	  <GmtCreate>1538017814000</GmtCreate>
	  <GmtModified>1538017814000</GmtModified>
	  <Params>ls -l</Params>
	  <MaxRetry>0</MaxRetry>
	  <Name>shell_copy</Name>
	  <Type>SHELL</Type>
	  <ResourceList></ResourceList>
	  <RetryInterval>15</RetryInterval>
	  <Id>FJ-C7FB9F1075C7****</Id>
	
</DescribeFlowJobResponse>

JSON 形式

{
	"FailAct":"STOP",
	"Description":"shell",
	"Type":"SHELL",
	"GmtCreate":1538017814000,
	"GmtModified":1538017814000,
	"Name":"shell_copy",
	"MaxRetry":0,
	"CategoryId":"FC-F2495319DA05CEE5",
	"RetryInterval"：15、
	"ResourceList":{
		"Resource":[]
	},
	"RequestId":"7D2B1B2E-8D89-49C1-8D31-097C83879D20",
	"Params":"ls -l",
	"Id":"FJ-C7FB9F1075C7****"
}

エラーコード

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