Querying Delivery Information

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.

dataspace_id

No

String

Data space ID.

pipe_id

No

String

Pipeline ID.

shipper_name

No

String

Delivery name.

shipper_source_region

No

String

Data source region.

shipper_source_strategy

No

String

Data source consumption policy.

shipper_consumption_type

No

String

Data source consumption type.

destination_shipper_type

No

String

Destination delivery type.

shipper_status

No

String

Data delivery status.

create_time

No

String

Creation time.

limit

No

Long

Number of records on each page.

offset

No

Long

Page number.

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

code

Integer

Error code. The value 0 indicates a success. Other values indicate an error.

data

ApiResponseData object

Data information.

msg

String

Returned status information, which describes the result of the current request.

data

Array of ApiResponseDataItem objects

Result data.

limit

Integer

Number of records displayed on each page.

offset

Integer

Start offset of the current page.

total

Integer

Total number of records.

consumption_type

Integer

Consumption type. It is defined based on services.

create_time

Long

Creation time, which is a timestamp in milliseconds.

dataspace_id

String

Data space ID, which is unique.

dataspace_name

String

Data space name.

domain_id

String

Domain ID, which is unique.

id

Integer

Unique ID.

pipe_id

String

Pipeline ID, which is unique.

pipe_name

String

Pipeline name.

project_id

String

Project ID, which is unique.

shipper_destination

ShipperDestination object

Delivery destination.

shipper_id

String

Shipping ID, which is unique.

shipper_name

String

Shipping name.

shipper_source

ShipperSource object

Delivery source.

status

Integer

Status code. The specific meaning depends on the service definition.

update_time

Long

Update time, which is a timestamp in milliseconds.

version

String

Version information.

workspace_id

String

Workspace ID, which uniquely identifies a workspace.

data_param

String

Data parameter, which is in JSON format.

data_type

Integer

Data type. It is defined based on services.

dataspace

String

Data space ID.

dataspace_name

String

Data space name.

destination_info

String

Details about the destination.

id

Integer

Unique ID.

identity

String

Identity ID.

pipe

String

Pipeline ID.

pipe_name

String

Pipeline name.

region

String

Region information.

type

Integer

Type code. It is defined based on services.

workspace

String

Workspace ID.

workspace_name

String

Workspace name.

data_type

Integer

Data type. It is defined based on services.

dataspace

String

Data space ID.

dataspace_name

String

Data space name.

id

Integer

Unique ID.

identity

String

Identity ID.

pipe

String

Pipeline ID.

pipe_name

String

Pipeline name.

region

String

Region information.

type

Integer

Type code. It is defined based on services.

workspace

String

Workspace ID.

workspace_name

String

Workspace name.

200

Successful.