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

デバッグ

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

リクエストパラメーター


パラメーター	データ型	必須／任意	例	説明
Action	String	必須	ListFlow	実行する操作です。値を ListFlow に設定します。
RegionId	String	必須	cn-hangzhou	クラスターが存在するリージョンの ID です。
ClusterId	String	任意	C-F32FB31D82954C64	クラスターの ID です。
Id	String	任意	F-A32FB31D82954C64	ワークフローの ID です。
JobId	String	任意	FJ-F32FB31D82954C64	ジョブの ID です。
Name	String	任意	my_flow	ワークフローの名前です。
PageNumber	Integer	任意	1	返されるページ数です。
PageSize	Integer	任意	20	返される各ページのエントリ数です。
Periodic	Boolean	任意	true	ワークフローの定期的なスケジュールの実行有無を指定します。
ProjectId	String	任意	FP-3535FE0BE5224A47	プロジェクトの ID です。
Status	String	任意	STOP_SCHEDULE	ワークフローのスケジュールステータスです。有効値： STOP_SCHEDULE：スケジューリング停止中 UNDER_SCHEDULE：スケジューリング中

レスポンスパラメーター


パラメーター	データ型	例	説明
Flow			ワークフローのリストです。
Flow			ワークフローに関する情報です。
AlertConf	String	"{\"items\":[{\"enable\":true,\"eventId\":\"EMR-210401001\",\"alertUserGroupIdList\":[\"AUG-52dabfbbca654b52aae05ac5acd9a0f0\"],\"alertDingDingGroupList\":[\"ADG-2c411c452e6b467b9a59fadf21d195ad\"]}]}"	ワークフローインスタンスのアラート設定です。
AlertDingDingGroupBizId	String	N/A	このパラメーターは使用できません。
AlertUserGroupBizId	String	N/A	このパラメーターは使用できません。
CategoryId	String	FC-2CF58396A18923B6	ワークフローのディレクトリ ID です。
ClusterId	String	C-F32FB31D82954C64	クラスターの ID です。
CreateCluster	Boolean	false	クラスターが、クラスターテンプレートから作成されたものであるかを示します。
CronExpr	String	0 0 0 * *？	ワークフローの時間ベースのスケジューリングの CRON 式です。
Description	String	my flow demo	ワークフローの説明です。
EndSchedule	Long	4102416001000	スケジューリングの終了時刻です。
GmtCreate	Long	1541561048000	ワークフローの作成時刻です。
GmtModified	Long	1542902401000	ワークフローの変更時刻です。
Graph	String	{"nodes":[{"id":"48d474ea","index":0,"spmAnchorId":"0.0.0.i0.766645eb2cmNtQ","attribute":{"type":"START"},"shape":"startControlNode","type":"node","y":250,"size":"8034","x":500},{"id":"7ba480b3","index":1,"spmAnchorId":"5176.8250060.0.i19.771e28d0IPNQGE","attribute":{"jobType":"SHELL","jobId":"FJ-7BE1062897B19D25","type":"JOB"},"config":{"hostName":""},"label":"fail_job","shape":"shellJobNode","type":"node","y":398.5,"size":"17034","x":470.5},{"id":"33202d60","index":2,"spmAnchorId":"5176.8250060.0.i23.771e28d0IPNQGE","attribute":{"type":"END"},"shape":"endControlNode","type":"node","y":562.5,"size":"80*34","x":430.5}],"edges":[{"id":"28167ea0","index":3,"source":"48d474ea","sourceAnchor":0,"target":"7ba480b3","targetAnchor":0},{"id":"e8d5ff52","index":4,"source":"7ba480b3","sourceAnchor":1,"target":"33202d60","targetAnchor":0}]}	ワークフローの有向非巡回グラフ (DAG) に関する情報です。
HostName	String	emr-header-1.cluster-123456	ワークフローインスタンスの実行のために指定されたホストの名前です。形式は次のとおりです： emr-header-1.cluster-123456。
Id	String	7A39731FE7196358	ワークフローの ID です。
Name	String	my_flow_demo	ワークフローの名前です。
Periodic	Boolean	true	ワークフローの定期的なスケジュール実行有無を示します。
ProjectId	String	FP-3535FE0BE5224A47	プロジェクトの ID です。
StartSchedule	Long	1541561443000	ワークフローのスケジュールの開始時刻です。
Status	String	UNDER_SCHEDULE	ワークフローのスケジュールステータスです。有効な値： STOP_SCHEDULE 、 UNDER_SCHEDULE 。
Type	String	EMR	ワークフローのタイプです。有効値: EMR 。
PageNumber	Integer	1	返されたページ数です。
PageSize	Integer	20	返された 1 ページあたりのエントリ数です。
RequestId	String	7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD	リクエストの ID です。
Total	Integer	1	返されたエントリの総数を示します。

例

リクエストの例


http(s)://[Endpoint]/? Action=ListFlow
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式

<ListFlowResponse>
  <PageSize>500</PageSize>
	  <RequestId>7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>1</Total>
	  <Flow>
		    <Flow>
			      <StartSchedule>1541561443000</StartSchedule>
			      <Status>UNDER_SCHEDULE</Status>
			      <CategoryId>FC-F2495319DA05CEE5</CategoryId>
			      <Description>daily_0</Description>
			      <ClusterId>C-F32FB31D8295****</ClusterId>
			      <GmtModified>1542902401000</GmtModified>
			      <ProjectId>FP-3535FE0BE5224A47</ProjectId>
			      <Periodic>true</Periodic>
			      <CronExpr>0 0 0 * * ? </CronExpr>
			      <Name>daily_0</Name>
			      <Type>EMR</Type>
			      <GmtCreate>1541561048000</GmtCreate>
			      <Id>F-D156B45E06F1****</Id>
			      <EndSchedule>4102416001000</EndSchedule>
			      <HostName></HostName>
			      <CreateCluster>false</CreateCluster>
		    </Flow>
	  </Flow>
	

</ListFlowResponse>

JSON 形式

{
	"Flow":{
		"Flow":[
			{
				"Description":"daily_0",
				"Type":"EMR",
				"CreateCluster":false,
				"CronExpr":"0 0 0 * * ?",
				"GmtCreate":1541561048000,
				"GmtModified":1542902401000,
				"HostName":"",
				"StartSchedule":1541561443000,
				"Name":"daily_0",
				"EndSchedule":4102416001000,
				"Status":"UNDER_SCHEDULE",
				"CategoryId":"FC-2CF58396A18923B6",
				"ClusterId":"C-F32FB31D8295****",
				"Periodic":true,
				"Id":"F-D156B45E06F1****",
				"ProjectId":"FP-3535FE0BE5224A47"
			}
		]
	},
	"PageNumber":1,
	"PageSize":500,
	"RequestId":"7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD",
	"Total":1
}

エラーコード

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