调用ListFlow接口，查询工作流列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListFlow

系统规定参数。取值：ListFlow。

RegionId String 是 cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
ProjectId String 否 FP-3535FE0BE522****

项目ID。您可以调用ListFlowProject查看项目的ID。
JobId String 否 FJ-F32FB31D8295****

作业ID。您可以调用ListFlowJob查看。
Name String 否 my_flow

工作流名称。您可以调用ListFlowInstance查看。
Id String 否 F-A32FB31D8295****

工作流ID。您可以调用ListFlowInstance查看工作流ID。
ClusterId String 否 C-F32FB31D8295****

集群ID。您可以调用ListClusters查看集群的ID。
Status String 否 STOP_SCHEDULE

状态：

  • STOP_SCHEDULE（停止调度）
  • UNDER_SCHEDULE（调度中）
Periodic Boolean 否 true

是否调度。
PageNumber Integer 否 1

页码。
PageSize Integer 否 20

每页查询数量。

返回数据

名称 类型 示例值 描述
RequestId String 7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD

请求ID。
PageNumber Integer 1

页码。
PageSize Integer 20

每页数量。
Total Integer 1

总数。
Flow Array of Flow

工作流列表
Flow
Status String STOP_SCHEDULE

支持状态：

  • STOP_SCHEDULE（停止调度）
  • UNDER_SCHEDULE（调度中）
Type String DATABRICKS_INSIGHT

目前只支持DATABRICKS_INSIGHT。
AlertUserGroupBizId String ADG-0a00d00abb7743ff9f812f1a997f3d87

报警用户组信息。
Periodic Boolean Periodic

是否周期执行：

  • true：周期执行。
  • false：非周期行执行。
ProjectId String ProjectId

项目ID。您可以调用ListFlowProject查看项目的ID。
HostName String emr-header-1.cluster-123456

指定运行的机器信息，格式为emr-header-1.cluster-123456。
GmtModified Long 1538017814000

修改时间。
Description String 这是一个创建工作流描述

工作流描述。
CreateCluster Boolean false

是否创建集群：

  • true：ClusterId为集群模板id（CT-XXXXXX）。
  • false：ClusterId为集群id（C-XXXXXX）。
StartSchedule Long 1538017814000

开始调度时间。
EndSchedule 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}]}

图形信息。
AlertDingDingGroupBizId String AUG-c917bbfaf6494bbfacdee69c8284967c

报警钉钉群信息。
GmtCreate Long 1538017814000

创建时间。
CategoryId String FC-F2495319DA05****

工作流目录ID。
CronExpr String 0 0 0-23/1 * * ?

调度Cron表达式。
Name String my_flow_demo

工作流名称。
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"]}]}

报警通知配置，eventId目前支持：

  • EMR-210401001（工作流失败报警）。
  • EMR-110401002（工作流成功通知）。
  • EMR-110401015（工作流节点失败报警）。
ClusterId String C-A23BD131A862****

集群或集群模板ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlow
&RegionId=cn-hangzhou
&ProjectId=FP-3535FE0BE522****
&JobId=FJ-F32FB31D8295****
&Name=my_flow
&Id=F-A32FB31D8295****
&ClusterId=C-F32FB31D8295****
&Status=STOP_SCHEDULE
&Periodic=true
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFlowResponse>
    <RequestId>7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <Total>1</Total>
    <Flow>
        <Status>STOP_SCHEDULE</Status>
        <Type>DATABRICKS_INSIGHT</Type>
        <AlertUserGroupBizId>ADG-0a00d00abb7743ff9f812f1a997f3d87</AlertUserGroupBizId>
        <Periodic>false</Periodic>
        <ProjectId>ProjectId</ProjectId>
        <HostName>emr-header-1.cluster-123456</HostName>
        <GmtModified>1538017814000</GmtModified>
        <Description>这是一个创建工作流描述</Description>
        <CreateCluster>false</CreateCluster>
        <StartSchedule>1538017814000</StartSchedule>
        <EndSchedule>1538017814000</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>
    </Flow>
</ListFlowResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD",
  "PageNumber" : 1,
  "PageSize" : 20,
  "Total" : 1,
  "Flow" : [ {
    "Status" : "STOP_SCHEDULE",
    "Type" : "DATABRICKS_INSIGHT",
    "AlertUserGroupBizId" : "ADG-0a00d00abb7743ff9f812f1a997f3d87",
    "Periodic" : false,
    "ProjectId" : "ProjectId",
    "HostName" : "emr-header-1.cluster-123456",
    "GmtModified" : 1538017814000,
    "Description" : "这是一个创建工作流描述",
    "CreateCluster" : false,
    "StartSchedule" : 1538017814000,
    "EndSchedule" : 1538017814000,
    "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****"
  } ]
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。