文档首页/IoT数据分析 IoTA/API参考/API列表/管道作业管理/获取管道作业列表
更新时间：2023-02-01 GMT+08:00
查看PDF
分享

获取管道作业列表

功能介绍

获取用户下的所有管道作业，支持分页。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/pipelines

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：1

最大长度：128

表2 Query参数

参数

是否必选

参数类型

描述

data_store_id

否

String

数据存储Id

最小长度：1

最大长度：100

data_store_group_id

否

String

存储组Id

最小长度：1

最大长度：100

data_source_id

否

String

数据源Id

最小长度：1

最大长度：100

pipeline_name

否

String

管道名称

最小长度：1

最大长度：64

operator_class_name

否

String

包含的管道类名

最小长度：1

最大长度：100

offset

否

Long

偏移量，表示从此偏移量开始查询，offset大于等于0

最小值：0

最大值：2147483647

limit

否

Integer

每页显示的条目数量

最小值：1

最大值：100

sync_status

否

Boolean

立即同步作业状态，默认是false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

最小长度：1

最大长度：65535

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Long

总数

最小值：0

最大值：2147483647

pipelines

Array of PipelineJobInfoDto objects

管道列表

表5 PipelineJobInfoDto

参数

参数类型

描述

pipeline_id

String

管道ID

最小长度：1

最大长度：100

pipeline_name

String

管道名称

最小长度：1

最大长度：64

data_source_id

String

数据源ID

最小长度：1

最大长度：100

data_store_list

Array of DataStoreDto objects

存储列表

pipeline_description

String

管道描述

最小长度：1

最大长度：100

tag_list

Array of TagInfoDto objects

存储列表

pipeline_state

String

管道状态

最小长度：1

最大长度：100

status

String

操作状态

最小长度：1

最大长度：100

rtu

Integer

运行管道的RTU个数

最小值：0

最大值：1000

created_time

String

创建时间

最小长度：24

最大长度：24

modified_time

String

修改时间

最小长度：24

最大长度：24

user_id

String

用户ID

最小长度：1

最大长度：100

has_savepoint

Boolean

已停止的管道作业是否有历史缓存数据

表6 DataStoreDto

参数

参数类型

描述

data_store_id

String

存储ID

最小长度：0

最大长度：100

data_store_group_id

String

存储组ID

最小长度：0

最大长度：100

product_id

String

产品ID

最小长度：0

最大长度：100

表7 TagInfoDto

参数

参数类型

描述

operator_id

String

算子Id

最小长度：0

最大长度：100

data_store_id

String

存储ID

最小长度：0

最大长度：100

tag

String

标签信息

最小长度：0

最大长度：1000

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：100

error_msg

String

错误消息

最小长度：0

最大长度：1024

请求示例

无

响应示例

状态码： 200

successful operation

{
  "count" : 2,
  "pipelines" : [ {
    "pipeline_id" : "J_78334317671403520",
    "pipeline_name" : "SMT设备告警处理",
    "data_source_id" : "5f36de9032393fb3ffc8c043",
    "data_store_list" : [ {
      "data_store_id" : "2a1c168c-524d-4323-a65c-91bfef190704",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de439aa3bcc02c02aa547"
    }, {
      "data_store_id" : "0ba0a7cd-da5f-4a49-afd7-49147a2ca949",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de417aa3bcc02c02aa4f6"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de465a6467502c0597655"
    }, {
      "data_store_id" : "b20ed1b6-610d-46b0-a89a-f3643df98ce3",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de459a6467502c059763b"
    }, {
      "data_store_id" : "a6c6cd6a-1954-480b-ac28-6e8f9a2ab45d",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de472a6467502c0597679"
    }, {
      "data_store_id" : "07969c42-3fd4-4b20-bdb2-69408a6bdc18",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de42aaa3bcc02c02aa522"
    } ],
    "pipeline_description" : "",
    "tag_list" : [ ],
    "pipeline_state" : "RUNNING",
    "status" : "SUBMIT_SUCCEED",
    "rtu" : 0,
    "created_time" : "2021-05-14T07:30:27.000Z",
    "modified_time" : "2021-05-14T07:36:00.000Z",
    "user_id" : "07d7cc195b8025e72ffcc01b1021e553",
    "has_savepoint" : false
  }, {
    "pipeline_id" : "J_78067567866601472",
    "pipeline_name" : "SMT产线设备数据接入",
    "data_source_id" : "5f36de9032393fb3ffc8c043",
    "data_store_list" : [ {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de465a6467502c0597655"
    }, {
      "data_store_id" : "07969c42-3fd4-4b20-bdb2-69408a6bdc18",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de42aaa3bcc02c02aa522"
    }, {
      "data_store_id" : "2a1c168c-524d-4323-a65c-91bfef190704",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de439aa3bcc02c02aa547"
    }, {
      "data_store_id" : "0ba0a7cd-da5f-4a49-afd7-49147a2ca949",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de417aa3bcc02c02aa4f6"
    }, {
      "data_store_id" : "b20ed1b6-610d-46b0-a89a-f3643df98ce3",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de459a6467502c059763b"
    }, {
      "data_store_id" : "a6c6cd6a-1954-480b-ac28-6e8f9a2ab45d",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de472a6467502c0597679"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de465a6467502c0597655"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de42aaa3bcc02c02aa522"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de439aa3bcc02c02aa547"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de417aa3bcc02c02aa4f6"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de459a6467502c059763b"
    }, {
      "data_store_id" : "ef6eacfc-aaf8-4576-83f6-a89282af6874",
      "data_store_group_id" : "d28b479d-2c09-46de-bb02-411e5c6f6c80",
      "product_id" : "609de472a6467502c0597679"
    } ],
    "pipeline_description" : "SMT产线设备数据接入作业",
    "tag_list" : [ ],
    "pipeline_state" : "RUNNING",
    "status" : "SUBMIT_SUCCEED",
    "rtu" : 2,
    "created_time" : "2021-05-11T08:50:34.000Z",
    "modified_time" : "2021-05-14T03:23:41.000Z",
    "user_id" : "07d7cc195b8025e72ffcc01b1021e553",
    "has_savepoint" : false
  } ]
}

状态码

状态码

描述

200

successful operation

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

错误码

请参见错误码。

父主题：管道作业管理

相关文档