Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Pipeline Management/ Querying the Pipeline List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Pipeline List

Function

This API is used to query the pipeline list.

Calling Method

For details, see Calling APIs.

URI

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

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

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Long

Definition

Data query limit.

Range

0-1000

Default Value

N/A

sort_key

No

String

Sorting by attribute.

sort_dir

No

String

Sorting order. The value can be ASC or DESC.

pipe_name_in_query

No

String

Pipeline name.

pipe_id_in_query

No

String

Pipeline ID.

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Count.

records

Array of PipeItem objects

Pipeline record.
Table 5 PipeItem

Parameter

Type

Description

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

create_time

Integer

Timestamp, in ms.

update_time

Integer

Timestamp, in ms.

delete_time

Integer

Timestamp, in ms.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent topic: Pipeline Management