获取数据管道详情 - ShowPipe
功能介绍
获取数据管道详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
pipe_id |
是 |
String |
管道ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
资源类型,例如 STREAMING_TO_INDEX |
|
create_by |
String |
创建者信息 |
|
create_time |
Long |
创建时间戳 |
|
delete_time |
Integer |
删除时间戳 |
|
description |
String |
描述信息 |
|
directory |
String |
目录路径 |
|
owner_type |
String |
所有者类型,例如 USER |
|
pipe_alias |
String |
管道别名 |
|
pipe_id |
String |
管道ID |
|
pipe_name |
String |
管道名称 |
|
process_error |
String |
处理错误状态,例如 NONE |
|
process_status |
String |
处理状态,例如 COMPLETED |
|
project_id |
String |
项目ID |
|
resources |
Array of IsapResource objects |
资源列表 |
|
schema |
Schema object |
格式 |
|
storage_setting |
StorageSetting object |
存储设置 |
|
update_by |
String |
更新者信息 |
|
update_time |
Long |
更新时间戳 |
|
workspace_id |
String |
工作空间ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
资源类型,例如 STREAMING 或 INDEX |
|
create_by |
String |
创建者信息 |
|
create_time |
Integer |
创建时间戳 |
|
data_classification |
String |
数据分类,例如 FACTUAL_DATA |
|
data_layering |
String |
数据分层,例如 ODS |
|
delete_time |
Integer |
删除时间戳 |
|
description |
String |
描述信息 |
|
directory |
String |
目录路径 |
|
display_setting |
display_setting object |
显示设置 |
|
format |
String |
数据格式,例如 JSON |
|
lock_status |
String |
锁定状态,例如 UNLOCKED |
|
owner_type |
String |
所有者类型,例如 USER |
|
pipe_id |
String |
管道ID |
|
process_error |
String |
处理错误状态,例如 NONE |
|
process_status |
String |
处理状态,例如 COMPLETED |
|
project_id |
String |
项目ID |
|
rw_type |
String |
读写类型,例如 READ_WRITE |
|
schema |
Schema object |
格式 |
|
storage_setting |
StorageSetting object |
存储设置 |
|
store_size_in_bytes |
Integer |
存储大小(字节) |
|
table_alias |
String |
表别名 |
|
table_id |
String |
表ID |
|
table_name |
String |
表名称 |
|
update_by |
String |
更新者信息 |
|
update_time |
Integer |
更新时间戳 |
|
workspace_id |
String |
工作空间ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
column_alias |
String |
列别名 |
|
column_name |
String |
列名称 |
|
display_by_default |
Boolean |
是否默认显示 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
columns |
Array of columns objects |
列 |
|
partition |
Array of strings |
分区 |
|
primary_key |
Array of strings |
主键 |
|
time_filter |
String |
时间过滤列 |
|
watermark_column |
String |
水印列 |
|
watermark_interval |
Number |
水印间隔 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
array |
Boolean |
是否为数组 |
|
column_data_type |
String |
列数据类型,例如 TIMESTAMP 或 INT |
|
column_data_type_setting |
String |
数据类型设置 |
|
column_name |
String |
列名称 |
|
column_sequence_number |
Integer |
列顺序号 |
|
column_type |
String |
列类型,例如 PHYSICAL |
|
column_type_setting |
String |
列类型设置 |
|
depth |
Integer |
深度 |
|
nullable |
Boolean |
是否允许为空 |
|
own_name |
String |
自有名称 |
|
parent_name |
String |
父名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_transformation_cu |
Number |
数据转换 CU |
|
index_replicas |
Integer |
索引副本数 |
|
index_shards |
Integer |
索引分片数 |
|
index_storage_period |
Integer |
索引存储周期 |
|
index_storage_size |
Integer |
索引存储大小 |
|
lake_storage_period |
Integer |
湖存储周期 |
|
streaming_bandwidth |
Number |
流式带宽 |
|
streaming_dataspace_id |
String |
流式数据空间ID |
|
streaming_partition |
Integer |
流式分区数 |
|
streaming_retention_size |
Integer |
流式保留大小 |
|
streaming_retention_time |
Integer |
流式保留时间 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
错误响应 |
错误码
请参见错误码。