跳转至

获取指定工作流的作业列表

本文介绍如何使用工作流的 API 获取指定工作流的作业列表。

API 路径

api-open/v1/workflows/<workflow_id>/jobs

<workflow_id>:工作流 ID。参见下文的请求参数。

请求参数

路径参数

参数 类型 是否必填 默认值 示例 说明
workflow_id number 必填 - 4216617528 工作流 ID。需要指定工作流将其实例化为作业。可以在指定的工作流页面左上角查看 ID。

Headers 参数

参数 类型 是否必填 默认值 示例 说明
Content-Type string 必填 - application/json 内容类型。
explorer_token string 必填 - eyJhbxxx 授权 Token,用于验证账号信息。如何获取授权 Token 请参见工作流 API 概览

Body 参数

参数 类型 是否必填 默认值 示例 说明
filter object 可选 - - 过滤器的设置。
   - name string 可选 - workflow_q745a_20220715092236 作业名称。
   - status number 可选 - 2 作业状态码。详情参见工作流 API 概览
   - fromCreateTime number 可选 - 1657848036000 起始时间戳。基于作业的创建时间进行过滤。
   - toCreateTime number 可选 - 1657848157000 结束时间戳。基于作业的创建时间进行过滤。
   - orderByCreateTime string 可选 desc - 排序方式。支持descasc
pageSize number 可选 10 - 每页记录数。
page number 可选 1 - 页码。

请求示例

Note

jobs?后的内容为 Body 参数,filter的内容是进过 URL 编码的结果。原始内容为:{"status": 2, "fromCreateTime": 1657874100000}

curl -i -X GET -H "Content-Type: application/json" -H "Cookie: "explorer_token=eyJhbxxx"" http://192.168.8.145:7002/api-open/v1/workflows/4216617528/jobs?filter=%7B%22status%22%3A%202%2C%20%20%22fromCreateTime%22%3A%201657874100000%7D&pageSize=10&page=1

返回参数

参数 类型 示例 说明
code number 0 请求结果码。请求成功返回0,请求不成功返回对应的错误码。详情参见工作流 API 概览
message string Success 执行结果信息。
data object - 返回的数据列表。
   - total number 2 记录总数。
   - Page number 1 页码。
   - PageSize number 10 每页记录数。
   - items object - 记录详情列表。
       - id number 105 作业 ID。
       - name string workflow_q745a_20220715090915 作业名称。
       - workflowId string 4216617528 工作流 ID。
       - workflowName string workflow_q745a 工作流名称。
       - status number 2 作业状态码。详情参见工作流 API 概览
       - runBeginTime number 1657847358000 作业开始执行时间。
       - runEndTime number 1657847364000 作业执行结束时间。
       - createTime number 1657847355906 作业创建时间。

返回示例

{
  "cookie": [],
  "Content-Type": "application/json",
  "Traceparent": "00-008c3056686dd3f3be38b8eda42a917e-b5616e30434cb803-00",
  "Date": "Fri, 15 Jul 2022 08:44:06 GMT",
  "Content-Length": "297"
}
{
  "code": 0,
  "data": {
    "items": [
      {
        "id": 115,
        "name": "workflow_q745a_20220715163650",
        "workflowId": "4216617528",
        "workflowName": "workflow_q745a",
        "status": 2,
        "runBeginTime": 1657874212000,
        "runEndTime": 1657874218000,
        "createTime": 1657874210088
      }
    ],
    "total": 1,
    "Page": 1,
    "PageSize": 10
  },
  "message": "Success"
}

最后更新: August 12, 2022