获取管道详情 - ShowPipe
功能介绍
获取管道详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
pipe_id |
是 |
String |
管道Id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
项目ID |
|
workspace_id |
String |
UUID |
|
pipe_id |
String |
UUID |
|
pipe_name |
String |
Pipe name |
|
pipe_alias |
String |
Pipe alias |
|
category |
String |
参数解释: 管道目录
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
directory |
String |
directory 目录分组 |
|
description |
String |
Pipe description |
|
process_status |
String |
参数解释: 作业处理状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
process_error |
String |
参数解释: 管道处理错误
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
owner_type |
String |
参数解释: 管道所有者类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
resources |
Array of PipeResource objects |
管道资源 |
|
schema |
PipeSchema object |
管道模式 |
|
create_time |
Integer |
毫秒时间戳 |
|
update_time |
Integer |
毫秒时间戳 |
|
delete_time |
Integer |
毫秒时间戳 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
columns |
Array of TableColumnForIsapPipe objects |
管道列 |
|
watermark_column |
String |
Pipe watermark column |
|
watermark_interval |
Float |
Pipe watermark delay interval |
|
time_filter |
String |
Pipe time filter column |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
column_name |
String |
Table column name |
|
column_data_type |
String |
参数解释: 列字段数据类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
column_data_type_setting |
String |
Table column data type setting |
|
column_type |
String |
参数解释: 列字段类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
column_type_setting |
String |
列类型设置 |
|
default_value |
String |
Table column default value |
|
nullable |
Boolean |
Table column nullable |
|
array |
Boolean |
Is an array |
|
depth |
Long |
Table column depth |
|
parent_name |
String |
Table column name |
|
own_name |
String |
Table column name without parent name |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
错误码
请参见错误码。