Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Data Delivery/ Querying Delivery Rule Details
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Delivery Rule Details

Function

This API is used to query delivery rule details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers/{shipper_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.

shipper_id

Yes

String

Delivery ID.

Request Parameters

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

data

data object

Delivery data.

msg

String

Response message.
Table 4 data

Parameter

Type

Description

consumption_type

Integer

Consumption type.

create_time

Long

Creation time (timestamp)

dataspace_id

String

Data space ID.

dataspace_name

String

Data space name.

domain_id

String

Domain ID.

id

Integer

Pipeline ID.

pipe_id

String

Pipeline ID.

pipe_name

String

Pipeline name.

project_id

String

Project ID.

shipper_destination

shipper_destination object

Delivery destination.

shipper_id

String

Delivery ID.

shipper_name

String

Delivery name.

shipper_source

shipper_source object

Delivery source.

status

Integer

Status.

update_time

Long

Update time (timestamp)

version

String

Version.

workspace_id

String

Workspace ID.

workspace_name

String

Workspace name.
Table 5 shipper_destination

Parameter

Type

Description

data_param

String

Destination parameters.

data_type

Integer

Data type.

dataspace

String

Data space.

dataspace_name

String

Data space name.

destination_info

String

Destination information.

id

Integer

Destination ID.

identity

String

ID.

pipe

String

Pipeline ID.

pipe_name

String

Pipeline name.

region

String

Region.

type

Integer

Type.

workspace

String

Workspace ID.

workspace_name

String

Workspace name.
Table 6 shipper_source

Parameter

Type

Description

data_type

Integer

Data type.

dataspace

String

Data space.

dataspace_name

String

Data space name.

id

Integer

Source ID.

identity

String

ID.

pipe

String

Pipeline ID.

pipe_name

String

Pipeline name.

region

String

Region.

type

Integer

Type.

workspace

String

Workspace ID.

workspace_name

String

Workspace name.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

400

Error response.

Error Codes

See Error Codes.

Parent topic: Data Delivery