この操作では、ワークフローを照会します。
デバッグ
リクエストパラメーター
| パラメーター | データ型 | 必須／任意 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | 必須 | DescribeFlow |
実行する操作です。 値を DescribeFlow に設定します。 |
| Id | String | 必須 | F-7A39731FE7196358 |
ワークフローの ID を設定します。 |
| ProjectId | String | 必須 | FP-257A173659F59685 |
プロジェクトの ID です。 |
| RegionId | String | 必須 | cn-hangzhou |
プロジェクトが配置されているリージョンの ID です。 |
レスポンスパラメーター
| パラメーター | データ型 | 例 | 説明 |
|---|---|---|---|
| AlertConf | String | {"items":[{"enable":true,"eventId":"EMR-210401001","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401015","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401002","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]}]} |
ワークフローインスタンスのアラート設定です。 eventId の有効値 ：
|
| AlertDingDingGroupBizId | String | AUG-c917bbfaf6494bbfacdee69c8284967c |
アラートの送信先の DingTalk グループの ID です。 |
| AlertUserGroupBizId | String | ADG-0a00d00abb7743ff9f812f1a997f3d87 |
アラートの送信先のユーザーグループの ID です。 |
| Application | String | {"nodeDefMap":{":start:":{"name":":start:","type":":start:","transitions":["cluster"]},"cluster":{"id":"CT-0C74281682CF03B4","name":"cluster","type":":Cluster:","transitions":["job1"]},"job1":{"jobId":"FJ-242AB240DBAF4195","name":"job1","type":":action:","transitions":["end"]},"end":{"name":"end","type":":end:"}}} |
nodeDefMap で表される、ワークフローの構造です。 nodeDefMap はノードのグループで構成されています。 type：現在のノードのタイプです。
|
| CategoryId | String | FC-F2495319DA05CEE5 |
ワークフローのディレクトリ ID です。 |
| ClusterId | String | C-A23BD131A862F184 |
対象のクラスターまたはクラスターテンプレートの ID です。 |
| CreateCluster | Boolean | false |
クラスターテンプレートから作成されたクラスターであるかを示します。
|
| CronExpr | String | 0 0 0-23/1 * * ? |
ワークフローの時間ベースのスケジューリングの CRON 式。 |
| Description | String | This is the description of a workflow |
ワークフローの説明です。 |
| EndSchedule | Long | 1538018814000 |
スケジューリングの終了時刻です。 |
| GmtCreate | Long | 1538017814000 |
ワークフローの作成時刻です。 |
| GmtModified | Long | 1538017814000 |
ワークフローの変更時刻です。 |
| Graph | String | {"nodes":[{"id":"48d474ea","index":0,"spmAnchorId":"0.0.0.i0.766645eb2cmNtQ","attribute":{"type":"START"},"shape":"startControlNode","type":"node","y":250,"size":"80*34","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":"170*34","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}]} |
The information of the directed acyclic graph (DAG) of the workflow. |
| HostName | String | emr-header-1.cluster-123456 |
ワークフローインスタンスを実行するために指定されたホストの名前です。 形式は emr-header-1.cluster-123456 です。 |
| Id | String | F-7A39731FE7196358 |
ワークフローの ID です。 |
| Name | String | my_flow_demo |
ワークフローの名前です。 |
| ParentFlowList |
照会されたワークフローの親ワークフローです。 |
||
| ParentFlow |
親ワークフローの情報です。 |
||
| ParentFlowId | String | F-123456 |
親ディレクトリの ID です。 |
| ParentFlowName | String | parent_flow |
親ワークフローの名前です。 |
| ProjectId | String | FP-257A173659F59685 |
プロジェクトの ID です。 |
| ProjectName | String | my_project |
プロジェクトの名前です。 |
| Periodic | Boolean | true |
ワークフローが定期的にスケジュールされているかを示します。 |
| RequestId | String | 243D5A48-96A5-4C0C-8966-93CBF65635ED |
リクエストの ID です。 |
| StartSchedule | Long | 1538017814000 |
スケジューリングの開始時刻です。 |
| Status | String | STOP_SCHEDULE |
ワークフローのスケジュールステータスです。 有効値：
|
| Type | String | EMR |
ワークフローのタイプです。 有効値：EMR 。 |
例
リクエストの例
http(s)://[Endpoint]/? Action=DescribeFlow
&Id=F-7A39731FE7196358
&ProjectId=FP-257A173659F59685
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>
通常のレスポンス例
XML 形式
<DescribeFlowResponse>
<alertUserGroupBizId></alertUserGroupBizId>
<Description>flow</Description>
<Type>EMR</Type>
<CreateCluster>false</CreateCluster>
<GmtCreate>1533294723000</GmtCreate>
<GmtModified>1535449545000</GmtModified>
<HostName></HostName>
<Name>flow</Name>
<Status>STOP_SCHEDULE</Status>
<ParentFlowList></ParentFlowList>
<CategoryId>FC-020BA6E39BF0DF35</CategoryId>
<alertDingDingGroupBizId></alertDingDingGroupBizId>
<ClusterId>C-23D6879E9BBE****</ClusterId>
<Periodic>false</Periodic>
<RequestId>E909BE04-1989-4751-93E6-1327FFC71EC0</RequestId>
<Graph>
<edges>
<id>af91f6b1</id>
<index>2</index>
<sourceAnchor>0</sourceAnchor>
<source>48d474ea</source>
<target>f2764af5</target>
<targetAnchor>0</targetAnchor>
</edges>
<edges>
<id>3022d5b9</id>
<index>4</index>
<source>48d474ea</source>
<sourceAnchor>0</sourceAnchor>
<target>ee4ee659</target>
<targetAnchor>0</targetAnchor>
</edges>
<edges>
<id>cfa94eec</id>
<index>6</index>
<source>f2764af5</source>
<sourceAnchor>1</sourceAnchor>
<target>75ba7979</target>
<targetAnchor>0</targetAnchor>
</edges>
<edges>
<id>00cd608a</id>
<index>7</index>
<source>ee4ee659</source>
<sourceAnchor>1</sourceAnchor>
<target>75ba7979</target>
<targetAnchor>0</targetAnchor>
</edges>
<edges>
<id>c53a4788</id>
<index>9</index>
<source>75ba7979</source>
<sourceAnchor>1</sourceAnchor>
<target>ea5b3e8f</target>
<targetAnchor>0</targetAnchor>
</edges>
<nodes>
<id>f2764af5</id>
<index>0</index>
<spmAnchorId>5176.8250060.0.i158.771e28d0IPNQGE</spmAnchorId>
<config>
<clusterId>C-E2544BF48603****</clusterId>
</config>
<attribute>
<jobType>SHELL</jobType>
<jobId>FJ-D9595F5B79ADBAD4</jobId>
<type>JOB</type>
</attribute>
<label>echo</label>
<shape>shellJobNode</shape>
<type>node</type>
<y>394.5</y>
<x>321.25</x>
<size>170*34</size>
</nodes>
<nodes>
<id>48d474ea</id>
<index>1</index>
<spmAnchorId>0.0.0.i0.766645eb2cmNtQ</spmAnchorId>
<attribute>
<type>START</type>
</attribute>
<shape>startControlNode</shape>
<type>node</type>
<y>262</y>
<size>80*34</size>
<x>500</x>
</nodes>
<nodes>
<id>ee4ee659</id>
<index>3</index>
<spmAnchorId>5176.8250060.0.i11.6bb528d0eMBmZQ</spmAnchorId>
<attribute>
<jobType>SHELL</jobType>
<jobId>FJ-7BE1062897B19D25</jobId>
<type>JOB</type>
</attribute>
<config>
<hostName></hostName>
</config>
<label>fail_job</label>
<shape>shellJobNode</shape>
<type>node</type>
<y>456.5</y>
<size>170*34</size>
<x>518.125</x>
</nodes>
<nodes>
<id>75ba7979</id>
<index>5</index>
<spmAnchorId>5176.8250060.0.i11.6bb528d0eMBmZQ</spmAnchorId>
<attribute>
<jobType>SHELL</jobType>
<jobId>FJ-D9595F5B79ADBAD4</jobId>
<type>JOB</type>
</attribute>
<config>
<hostName>emr-header-1.cluster-71886</hostName>
<clusterId>C-7CE7BC10276E24BE</clusterId>
</config>
<label>echo</label>
<shape>shellJobNode</shape>
<type>node</type>
<y>585.5</y>
<size>170*34</size>
<x>250.125</x>
</nodes>
<nodes>
<id>ea5b3e8f</id>
<index>8</index>
<spmAnchorId>5176.8250060.0.i19.6bb528d0eMBmZQ</spmAnchorId>
<attribute>
<type>END</type>
</attribute>
<shape>endControlNode</shape>
<type>node</type>
<y>700.5</y>
<size>80*34</size>
<x>239.125</x>
</nodes>
</Graph>
<Id>F-7A39731FE7196358</Id>
</DescribeFlowResponse>JSON 形式
{
"alertUserGroupBizId":"",
"Description":"flow",
"Type":"EMR",
"CreateCluster":false,
"GmtCreate":1533294723000,
"GmtModified":1535449545000,
"HostName":"",
"Name":"flow",
"Status":"STOP_SCHEDULE",
"ParentFlowList":{
"ParentFlow":[]
},
"CategoryId":"FC-020BA6E39BF0DF35",
"alertDingDingGroupBizId":"",
"ClusterId":"C-23D6879E9BBE****",
"Periodic":false,
"RequestId":"E909BE04-1989-4751-93E6-1327FFC71EC0",
"Graph":{
"edges":[
{
"id":"af91f6b1",
"index":2,
"source":"48d474ea",
"sourceAnchor":0,
"target":"f2764af5",
"targetAnchor":0
},
{
"id":"3022d5b9",
"index":4,
"sourceAnchor":0,
"source":"48d474ea",
"target":"ee4ee659",
"targetAnchor":0
},
{
"id":"cfa94eec",
"index":6,
"sourceAnchor":1,
"source":"f2764af5",
"target":"75ba7979",
"targetAnchor":0
},
{
"id":"00cd608a",
"index":7,
"sourceAnchor":1,
"source":"ee4ee659",
"target":"75ba7979",
"targetAnchor":0
},
{
"id":"c53a4788",
"index":9,
"sourceAnchor":1,
"source":"75ba7979",
"target":"ea5b3e8f",
"targetAnchor":0
}
],
"nodes":[
{
"id":"f2764af5",
"index":0,
"spmAnchorId":"5176.8250060.0.i158.771e28d0IPNQGE",
"attribute":{
"jobType":"SHELL",
"jobId":"FJ-D9595F5B79ADBAD4",
"type":"JOB"
},
"config":{
"clusterId":"C-E2544BF48603****"
},
"label":"echo",
"shape":"shellJobNode",
"type":"node",
"y":394.5,
"size":"170*34",
"x":321.25
},
{
"id":"48d474ea",
"index":1,
"spmAnchorId":"0.0.0.i0.766645eb2cmNtQ",
"attribute":{
"type":"START"
},
"shape":"startControlNode",
"type":"node",
"y":262,
"x":500,
"size":"80*34"
},
{
"id":"ee4ee659",
"index":3,
"spmAnchorId":"5176.8250060.0.i11.6bb528d0eMBmZQ",
"config":{
"hostName":""
},
"attribute":{
"jobType":"SHELL",
"jobId":"FJ-7BE1062897B19D25",
"type":"JOB"
},
"label":"fail_job",
"shape":"shellJobNode",
"type":"node",
"y":456.5,
"x":518.125,
"size":"170*34"
},
{
"id":"75ba7979",
"index":5,
"spmAnchorId":"5176.8250060.0.i11.6bb528d0eMBmZQ",
"config":{
"hostName":"emr-header-1.cluster-71886",
"clusterId":"C-7CE7BC10276E24BE"
},
"attribute":{
"jobType":"SHELL",
"jobId":"FJ-D9595F5B79ADBAD4",
"type":"JOB"
},
"label":"echo",
"shape":"shellJobNode",
"type":"node",
"y":585.5,
"x":250.125,
"size":"170*34"
},
{
"id":"ea5b3e8f",
"index":8,
"spmAnchorId":"5176.8250060.0.i19.6bb528d0eMBmZQ",
"attribute":{
"type":"END"
},
"shape":"endControlNode",
"type":"node",
"y":700.5,
"x":239.125,
"size":"80*34"
}
]
},
"Id":"F-7A39731FE7196358"
}エラーコード
エラーコードについては、「API エラーセンター」をご参照ください。