获取实时作业列表
功能介绍
获取用户下的所有实时分析作业,支持分页。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/streaming/jobs
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID 最小长度:1 最大长度:128 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
job_input_type | 否 | String | 接收数据类型。 最小长度:1 最大长度:100 枚举值:
|
offset | 否 | Long | 偏移量,表示从此偏移量开始查询,offset大于等于0 最小值:0 最大值:2147483647 |
limit | 否 | Integer | 每页显示的条目数量 最小值:1 最大值:100 |
sync_status | 否 | Boolean | 立即同步作业状态,默认是false |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 租户Token 最小长度:1 最大长度:65535 |
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Long | 总数 最小值:0 最大值:2147483647 |
jobs | Array of StreamingJobInfoDto objects | 作业列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
job_id | String | 作业ID 最小长度:1 最大长度:100 |
job_name | String | 作业名称 最小长度:1 最大长度:20 |
job_input_type | String | 接收数据类型 最小长度:1 最大长度:100 |
job_description | String | 作业描述 最小长度:1 最大长度:100 |
job_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 | 已停止作业是否有历史缓存数据 |
状态码: 400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度:1 最大长度:100 |
error_msg | String | 错误消息 最小长度:0 最大长度:1024 |
状态码: 401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度:1 最大长度:100 |
error_msg | String | 错误消息 最小长度:0 最大长度:1024 |
状态码: 403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度:1 最大长度:100 |
error_msg | String | 错误消息 最小长度:0 最大长度:1024 |
状态码: 500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度:1 最大长度:100 |
error_msg | String | 错误消息 最小长度:0 最大长度:1024 |
请求示例
无
响应示例
状态码: 200
successful operation
{
"count" : 1,
"jobs" : [ {
"job_id" : "J_78253507867025408",
"job_name" : "pipeline_test",
"job_input_type" : "PIPELINE_DATA",
"job_description" : "",
"job_state" : "DRAFT",
"status" : "CHECK_FAILED",
"rtu" : 0,
"created_time" : "2021-05-13T10:06:01.000Z",
"modified_time" : "2021-08-20T07:45:43.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 |
错误码
请参见错误码。

