Querying Pipeline Details

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

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.

pipe_id

Yes

String

Pipeline ID.

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

project_id

String

Project ID.

workspace_id

String

UUID

pipe_id

String

UUID

pipe_name

String

Pipe name

pipe_alias

String

Pipe alias

category

String

Definition

Pipeline directory.

• STREAMING_TO_INDEX: writing data to indexes in streams

• STREAMING_TO_LAKE: writing data to data lakes in streams

• STREAMING_TO_INDEX_LAKE: writing data to indexes and data lakes in streams

• STREAMING: transmitting data in streams

Constraints

N/A

Range

• STREAMING_TO_INDEX

• STREAMING_TO_LAKE

• STREAMING_TO_INDEX_LAKE

• STREAMING

Default Value

N/A

directory

String

Directory group.

description

String

Pipe description

process_status

String

Definition

Job processing status.

• COMPLETED: completed.

• CREATING: being created

• UPDATING: being updated

• DELETING: being deleted

• UPDATING_FAILED: update failed

• DELETING_FAILED: deletion failed

Constraints

N/A

Range

• COMPLETED

• CREATING

• UPDATING

• DELETING

• UPDATING_FAILED

• DELETING_FAILED

Default Value

N/A

process_error

String

Definition

Pipeline processing error.

• NONE

Constraints

N/A

Range

• NONE

Default Value

N/A

owner_type

String

Definition

Pipeline owner type.

• SYSTEM: system

• USER: user

• CLOUD_LOG: cloud logs

Constraints

N/A

Range

• SYSTEM

• USER

• CLOUD_LOG

Default Value

N/A

resources

Array of PipeResource objects

Pipeline resource.

schema

PipeSchema object

Pipeline mode.

create_time

Integer

Timestamp, in ms.

update_time

Integer

Timestamp, in ms.

delete_time

Integer

Timestamp, in ms.

pipe_resource_type

Object

Pipeline resource.

columns

Array of TableColumnForIsapPipe objects

Pipeline column.

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

Definition

Column data type.

• ROW: row type

• MAP_STRING: string mapping type

• MAP_DECIMAL: decimal mapping type

• TINYINT: tiny integer

• SMALLINT: small integer

• INT: integer

• BIGINT: long integer

• DECIMAL: decimal data type

• FLOAT: single-precision floating point

• DOUBLE: double-precision floating point

• CHAR: fixed-length string

• VARCHAR: variable-length string

• STRING: string type

• KEYWORD: keyword type

• BOOLEAN: boolean type

• DATE: date type

• TIME: time type

• TIMESTAMP: timestamp type

• TIMESTAMP_LTZ: local timestamp type

Constraints

N/A

Range

• ROW

• MAP_STRING

• MAP_DECIMAL

• TINYINT

• SMALLINT

• INT

• BIGINT

• DECIMAL

• FLOAT

• DOUBLE

• CHAR

• VARCHAR

• STRING

• KEYWORD

• BOOLEAN

• DATE

• TIME

• TIMESTAMP

• TIMESTAMP_LTZ

Default Value

N/A

column_data_type_setting

String

Table column data type setting

column_type

String

Definition

Column field type.

• PHYSICAL: physical field

• METADATA: metadata field

• VIRTUAL_METADATA: virtual metadata field

• COMPUTED: computation field

Constraints

N/A

Range

• PHYSICAL

• METADATA

• VIRTUAL_METADATA

• COMPUTED

Default Value

N/A

column_type_setting

String

Column type settings.

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

Request succeeded.