调用ListFlow接口,查询工作流列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListFlow |
系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值: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 |
状态:
|
Periodic | Boolean | 否 | true |
是否调度。 |
PageNumber | Integer | 否 | 1 |
页码。 |
PageSize | Integer | 否 | 20 |
每页查询数量。 |
返回数据
示例
请求示例
http(s)://[Endpoint]/?Action=ListFlow
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<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-2CF58396A189****</CategoryId>
<Description>daily_0</Description>
<ClusterId>C-F32FB31D8295****</ClusterId>
<GmtModified>1542902401000</GmtModified>
<ProjectId>FP-3535FE0BE522****</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/>
<CreateCluster>false</CreateCluster>
</Flow>
</Flow>
JSON
格式
{
"PageSize": 500,
"RequestId": "7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD",
"PageNumber": 1,
"Total": 1,
"Flow": {
"Flow": [
{
"StartSchedule": 1541561443000,
"Status": "UNDER_SCHEDULE",
"CategoryId": "FC-2CF58396A189****",
"Description": "daily_0",
"ClusterId": "C-F32FB31D8295****",
"GmtModified": 1542902401000,
"ProjectId": "FP-3535FE0BE522****",
"Periodic": true,
"CronExpr": "0 0 0 * * ?",
"Name": "daily_0",
"Type": "EMR",
"GmtCreate": 1541561048000,
"Id": "F-D156B45E06F1****",
"EndSchedule": 4102416001000,
"HostName": "",
"CreateCluster": false
}
]
}
}