Obtaining Data Pipeline Details

This API is used to obtain data pipeline details.

For details, see Calling APIs.

GET /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.
pipe_id	Yes	String	Pipeline ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
category	String	Resource type, for example, STREAMING_TO_INDEX.
create_by	String	Creator information.
create_time	Long	Creation timestamp.
delete_time	Integer	Deletion timestamp.
description	String	Description.
directory	String	Directory path.
owner_type	String	Owner type, for example, USER.
pipe_alias	String	Pipeline alias.
pipe_id	String	Pipeline ID.
pipe_name	String	Pipeline name.
process_error	String	Processing error status, for example, NONE.
process_status	String	Processing status, for example, COMPLETED.
project_id	String	Project ID.
resources	Array of IsapResource objects	Resource list.
schema	Schema object	Format.
storage_setting	StorageSetting object	Storage settings.
update_by	String	Updater information.
update_time	Long	Update timestamp.
workspace_id	String	Workspace ID.

**Table 4** IsapResource
Parameter	Type	Description
category	String	Resource type, for example, STREAMING or INDEX.
create_by	String	Creator information.
create_time	Integer	Creation timestamp.
data_classification	String	Data classification, for example, FACTUAL_DATA.
data_layering	String	Data layers, for example, ODS.
delete_time	Integer	Deletion timestamp.
description	String	Description.
directory	String	Directory path.
display_setting	display_setting object	Display settings.
format	String	Data format, for example, JSON.
lock_status	String	Lock status, for example, UNLOCKED.
owner_type	String	Owner type, for example, USER.
pipe_id	String	Pipeline ID.
process_error	String	Processing error status, for example, NONE.
process_status	String	Processing status, for example, COMPLETED.
project_id	String	Project ID.
rw_type	String	Read/Write type, for example, READ_WRITE.
schema	Schema object	Format.
storage_setting	StorageSetting object	Storage settings.
store_size_in_bytes	Integer	Storage size (in byte).
table_alias	String	Table alias.
table_id	String	Table ID.
table_name	String	Table name.
update_by	String	Updater information.
update_time	Integer	Update timestamp.
workspace_id	String	Workspace ID.

**Table 5** display_setting
Parameter	Type	Description
columns	Array of columns objects	Column.
format	String	Display format, for example, TABLE.

**Table 6** columns
Parameter	Type	Description
column_alias	String	Column alias.
column_name	String	Column name.
display_by_default	Boolean	Whether to display by default.

**Table 8** columns
Parameter	Type	Description
array	Boolean	Array or not.
column_data_type	String	Column data type, for example, TIMESTAMP or INT.
column_data_type_setting	String	Data type settings.
column_name	String	Column name.
column_sequence_number	Integer	Column No.
column_type	String	Column type, for example, PHYSICAL.
column_type_setting	String	Column type settings.
depth	Integer	Depth.
nullable	Boolean	Whether the value can be empty.
own_name	String	In-house name.
parent_name	String	Parent name.

**Table 9** StorageSetting
Parameter	Type	Description
data_transformation_cu	Number	Data conversion CU.
index_replicas	Integer	Number of index replicas.
index_shards	Integer	Number of index shards.
index_storage_period	Integer	Index storage period.
index_storage_size	Integer	Index storage size.
lake_storage_period	Integer	Lake storage period.
streaming_bandwidth	Number	Streaming bandwidth.
streaming_dataspace_id	String	Streaming data space ID.
streaming_partition	Integer	Number of streaming partitions.
streaming_retention_size	Integer	Reserved stream size.
streaming_retention_time	Integer	Reserved stream time.