調(diào)用DescribeFlow接口,查詢工作流信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱(chēng) | 類(lèi)型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeFlow |
系統(tǒng)規(guī)定參數(shù)。取值:DescribeFlow。 |
ProjectId | String | 是 | FP-257A173659F5**** |
工作流ID |
Id | String | 是 | F-7A39731FE719**** |
項(xiàng)目ID |
RegionId | String | 是 | cn-hangzhou |
地域ID |
返回?cái)?shù)據(jù)
名稱(chēng) | 類(lèi)型 | 示例值 | 描述 |
---|---|---|---|
Status | String | STOP_SCHEDULE |
支持狀態(tài):
|
Type | String | DDI |
目前只支持DDI |
AlertUserGroupBizId | String | ADG-0a00d00abb7743ff9f812f1a997f3d87 |
報(bào)警用戶組信息。 |
Periodic | Boolean | true |
是否周期執(zhí)行:
|
EditLockDetail | String | {} |
編輯鎖信息。 |
Namespace | String | 無(wú) |
保留參數(shù)。 |
HostName | String | emr-header-1.cluster-123456 |
指定運(yùn)行的機(jī)器信息,格式為emr-header-1.cluster-123456。 |
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:"}}} |
工作流構(gòu)造信息,由一組節(jié)點(diǎn)定義nodeDefMap組成,多個(gè)時(shí)以逗號(hào)分隔。 type:類(lèi)型包括開(kāi)始節(jié)點(diǎn)(:start:)、構(gòu)建按需集群節(jié)點(diǎn)(:Cluster:)、動(dòng)作節(jié)點(diǎn)(:action:)和結(jié)束節(jié)點(diǎn)(:end:)。 transitions:下游的節(jié)點(diǎn)。 |
GmtModified | Long | 1538017814000 |
修改時(shí)間。 |
RequestId | String | 243D5A48-96A5-4C0C-8966-93CBF65635ED |
請(qǐng)求ID。 |
Description | String | 這是一個(gè)創(chuàng)建工作流描述 |
工作流描述。 |
CreateCluster | Boolean | false |
是否創(chuàng)建集群:
|
StartSchedule | Long | 1538017814000 |
開(kāi)始調(diào)度時(shí)間。 |
EndSchedule | Long | 1538018814000 |
結(jié)束調(diào)度時(shí)間。 |
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}]} |
圖形信息。 |
AlertDingDingGroupBizId | String | AUG-c917bbfaf6494bbfacdee69c8284967c |
報(bào)警釘釘群信息。 |
GmtCreate | Long | 1538017814000 |
創(chuàng)建時(shí)間。 |
CategoryId | String | FC-F2495319DA05**** |
工作流目錄ID。 |
CronExpr | String | 0 0 0-23/1 * * ? |
調(diào)度Cron表達(dá)式。 |
Name | String | my_flow_demo |
工作流名稱(chēng)。 |
Id | String | F-7A39731FE719**** |
工作流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"]}]} |
報(bào)警通知配置,eventId目前支持:
|
ClusterId | String | C-A23BD131A862**** |
集群/集群模板ID。 |
ParentFlowList | Array of ParentFlow | ||
ParentFlow | |||
ParentFlowName | String | parent_flow |
父工作流名稱(chēng)。 |
ParentFlowId | String | 173659F59685 |
父工作流ID。 |
ProjectName | String | my_project |
項(xiàng)目名稱(chēng)。 |
ProjectId | String | FP-257A173659F59685 |
項(xiàng)目ID。 |
示例
請(qǐng)求示例
http(s)://[Endpoint]/?Action=DescribeFlow
&ProjectId=FP-257A173659F5****
&Id=F-7A39731FE719****
&RegionId=cn-hangzhou
&公共請(qǐng)求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeFlowResponse>
<Status>STOP_SCHEDULE</Status>
<Type>DDI</Type>
<AlertUserGroupBizId>ADG-0a00d00abb7743ff9f812f1a997f3d87</AlertUserGroupBizId>
<Periodic>true</Periodic>
<EditLockDetail>{}</EditLockDetail>
<Namespace>無(wú)</Namespace>
<HostName>emr-header-1.cluster-123456</HostName>
<Application>{"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:"}}}</Application>
<GmtModified>1538017814000</GmtModified>
<RequestId>243D5A48-96A5-4C0C-8966-93CBF65635ED</RequestId>
<Description>這是一個(gè)創(chuàng)建工作流描述</Description>
<CreateCluster>false</CreateCluster>
<StartSchedule>1538017814000</StartSchedule>
<EndSchedule>1538018814000</EndSchedule>
<Graph>{"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}]}</Graph>
<AlertDingDingGroupBizId>AUG-c917bbfaf6494bbfacdee69c8284967c</AlertDingDingGroupBizId>
<GmtCreate>1538017814000</GmtCreate>
<CategoryId>FC-F2495319DA05****</CategoryId>
<CronExpr>0 0 0-23/1 * * ?</CronExpr>
<Name>my_flow_demo</Name>
<Id>F-7A39731FE719****</Id>
<AlertConf>{"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"]}]}</AlertConf>
<ClusterId>C-A23BD131A862****</ClusterId>
<ParentFlowList>
<ParentFlowName>parent_flow</ParentFlowName>
<ParentFlowId>173659F59685</ParentFlowId>
<ProjectName>my_project</ProjectName>
<ProjectId>FP-257A173659F59685</ProjectId>
</ParentFlowList>
</DescribeFlowResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Status" : "STOP_SCHEDULE",
"Type" : "DDI",
"AlertUserGroupBizId" : "ADG-0a00d00abb7743ff9f812f1a997f3d87",
"Periodic" : true,
"EditLockDetail" : "{}",
"Namespace" : "無(wú)",
"HostName" : "emr-header-1.cluster-123456",
"Application" : "{\"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:\"}}}",
"GmtModified" : 1538017814000,
"RequestId" : "243D5A48-96A5-4C0C-8966-93CBF65635ED",
"Description" : "這是一個(gè)創(chuàng)建工作流描述",
"CreateCluster" : false,
"StartSchedule" : 1538017814000,
"EndSchedule" : 1538018814000,
"Graph" : "{\"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}]}",
"AlertDingDingGroupBizId" : "AUG-c917bbfaf6494bbfacdee69c8284967c",
"GmtCreate" : 1538017814000,
"CategoryId" : "FC-F2495319DA05****",
"CronExpr" : "0 0 0-23/1 * * ?",
"Name" : "my_flow_demo",
"Id" : "F-7A39731FE719****",
"AlertConf" : "{\"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\"]}]}",
"ClusterId" : "C-A23BD131A862****",
"ParentFlowList" : [ {
"ParentFlowName" : "parent_flow",
"ParentFlowId" : "173659F59685",
"ProjectName" : "my_project",
"ProjectId" : "FP-257A173659F59685"
} ]
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。