更新时间:2026-04-30 GMT+08:00
分享

查询算子列表-QueryProcessorList

功能介绍

查询算子列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:dataProcessors:list

    List

    workspace *

    -

    -

    -

URI

GET /v1.0/{project_id}/data/processors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方法请参见获取项目ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

String

参数解释

工作空间ID

约束限制

不涉及

取值范围

不涉及

默认取值

0

id

Long

参数解释

算子ID

约束限制

不涉及

取值范围

最小值为1

默认取值

不涉及

name

String

参数解释

算子名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

output_type

Array of strings

参数解释

输出类型

  • DATA_MARK:数据标记

  • OPEN_DATA:数据回放

  • DATA_SET:数据集

  • REPLAY_SIM:回放仿真

  • PLOT_DATA:数据图表

约束限制

最多10个

limit

Integer

参数解释

列表返回的最大记录数

约束限制

最小为1,最大为200

取值范围

不涉及

默认取值

10

offset

Integer

参数解释

查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空

约束限制

最小值0

取值范围

不涉及

默认取值

0

sort

String

参数解释

排序方式

约束限制

不涉及

取值范围

  • CREATE_ASC:创建时间升序

  • CREATE_DESC:创建时间降序

  • UPDATE_ASC:更新时间升序

  • UPDATE_DESC:更新时间降序

默认取值

UPDATE_DESC

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

Content-Type

String

参数解释

内容类型。填application/json

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

payload

DataProcessorPayload object

参数解释

实际返回信息

meta_info

RespMetaInfo object

参数解释

元数据

表5 DataProcessorPayload

参数

参数类型

描述

list

Array of processorVo objects

参数解释

算子列表

page_info

PageInfo object

参数解释

分页信息

表6 processorVo

参数

参数类型

描述

id

Long

参数解释

算子ID

取值范围

不涉及

user_id

String

参数解释

用户ID

取值范围

不涉及

project_id

String

参数解释

项目ID

取值范围

不涉及

output_type

String

参数解释

输出类型

取值范围

  • DATA_MARK:数据标记

  • OPEN_DATA:数据回放

  • DATA_SET:数据集

  • REPLAY_SIM:回放仿真

  • PLOT_DATA:数据图表

config

DataProcessorConfigRequest object

参数解释

算子配置

name

String

参数解释

算子名称

取值范围

不涉及

description

String

参数解释

算子描述

取值范围

不涉及

visibility

String

参数解释

可见范围

取值范围

  • PRIVATE:仅创建者可见

  • PUBLIC:同一个projectId下的用户可见

update_at

Long

参数解释

更新时间,UTC标准时间毫秒时间戳

取值范围

不涉及

create_at

Long

参数解释

创建时间,UTC标准时间毫秒时间戳

取值范围

不涉及

image_repo_id

Integer

参数解释

镜像仓库ID

取值范围

不涉及

image_version

Integer

参数解释

镜像仓库版本号

取值范围

不涉及

workspace_id

String

参数解释

工作空间ID

取值范围

不涉及

表7 DataProcessorConfigRequest

参数

参数类型

描述

command

String

参数解释

启动命令

取值范围

不涉及

表8 PageInfo

参数

参数类型

描述

offset

Integer

参数解释

查询偏移量

取值范围

不涉及

limit

Integer

参数解释

返回个数上限

取值范围

不涉及

total

Integer

参数解释

资源总数

取值范围

不涉及

表9 RespMetaInfo

参数

参数类型

描述

current_time

String

参数解释

请求时间,UTC时间格式,时间为UTC标准时间

取值范围

不涉及

请求示例

算子列表

GET https://{endpoint}/v1.0/{project_id}/data/processors?offset=0&limit=10

响应示例

状态码:200

查询成功

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "list" : [ {
      "id" : 10000,
      "user_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
      "output_type" : "DATA_MARK",
      "config" : {
        "command" : "this is command"
      },
      "name" : "processor",
      "description" : "this is description",
      "visibility" : "PUBLIC",
      "create_at" : 1640966400000,
      "update_at" : 1640966400000,
      "image_repo_id" : 10000,
      "image_version" : 1
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 10,
      "total" : 1
    }
  }
}

状态码

状态码

描述

200

查询成功

400

请求参数错误

403

权限校验失败

500

系统内部错误

错误码

请参见错误码

相关文档