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

获取管道列表

功能介绍

获取管道列表

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/pipes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

参数解释:

偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

Long

参数解释:

查询数据限制

取值范围:

0-1000

默认取值:

不涉及

sort_key

String

按照属性排序。

sort_dir

String

排序顺序,支持 ASCDESC

pipe_name_in_query

String

管道名称

pipe_id_in_query

String

管道Id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

计数

records

Array of PipeItem objects

管道记录

表5 PipeItem

参数

参数类型

描述

project_id

String

项目ID

workspace_id

String

UUID

pipe_id

String

UUID

pipe_name

String

Pipe name

pipe_alias

String

Pipe alias

category

String

参数解释:

管道目录

  • STREAMING_TO_INDEX 流式写入索引

  • STREAMING_TO_LAKE 流式写入数据湖

  • STREAMING_TO_INDEX_LAKE 流式写入索引和数据湖

  • STREAMING 流式传输中

约束限制

不涉及

取值范围:

  • STREAMING_TO_INDEX

  • STREAMING_TO_LAKE

  • STREAMING_TO_INDEX_LAKE

  • STREAMING

默认值

不涉及

directory

String

directory 目录分组

description

String

Pipe description

process_status

String

参数解释:

作业处理状态

  • COMPLETED 已完成

  • CREATING 创建中

  • UPDATING 更新中

  • DELETING 删除中

  • UPDATING_FAILED 更新失败

  • DELETING_FAILED 删除失败

约束限制

不涉及

取值范围:

  • COMPLETED

  • CREATING

  • UPDATING

  • DELETING

  • UPDATING_FAILED

  • DELETING_FAILED

默认值

不涉及

process_error

String

参数解释:

管道处理错误

  • NONE 无

约束限制

不涉及

取值范围:

  • NONE

默认值

不涉及

owner_type

String

参数解释:

管道所有者类型

  • SYSTEM 系统

  • USER 用户

  • CLOUD_LOG 云日志

约束限制

不涉及

取值范围:

  • SYSTEM

  • USER

  • CLOUD_LOG

默认值

不涉及

create_time

Integer

毫秒时间戳

update_time

Integer

毫秒时间戳

delete_time

Integer

毫秒时间戳

请求示例

响应示例

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档