Creating a Data Delivery

Function

This API is used to create a data delivery.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/siem/shippers

**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.

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
consumption_type	No	Integer	Consumption type. 0: real-time; 1: scheduling.
dataspace_id	No	String	Data space ID.
dataspace_name	No	String	Data space name.
domain_id	No	String	Tenant ID.
pipe_id	No	String	Pipeline ID.
pipe_name	No	String	Pipeline name.
project_id	No	String	Project ID.
shipper_destination	No	shipper_destination object	Delivery destination.
shipper_name	No	String	Delivery name.
shipper_source	No	shipper_source object	Delivery source.
version	No	String	Version information.
workspace_id	No	String	Workspace ID.
workspace_name	No	String	Workspace name.

**Table 4** shipper_destination
Parameter	Mandatory	Type	Description
data_param	No	String	Data parameters.
destination_dataspace	No	String	Destination data space ID.
destination_dataspace_name	No	String	Destination data space name.
destination_identity_role	No	String	Destination identity role.
destination_table	No	String	Destination table ID.
destination_table_name	No	String	Destination table name.
destination_pipe	No	String	Destination pipeline ID.
destination_pipe_name	No	String	Destination pipeline name.
destination_region	No	String	Destination region information.
destination_shipper_type	No	Integer	Destination delivery type.
destination_workspace	No	String	Destination workspace ID.
destination_workspace_name	No	String	Destination workspace name.

**Table 5** shipper_source
Parameter	Mandatory	Type	Description
region	No	String	Region information.
source_dataspace	No	String	Source data space ID.
source_dataspace_name	No	String	Source data space name.
source_identity_role	No	String	Source identity role.
source_table	No	String	Source table ID.
source_table_name	No	String	Source table name.
source_pipe	No	String	Source pipeline ID.
source_pipe_name	No	String	Source pipeline name.
source_type	No	Integer	Source type.
source_workspace	No	String	Source workspace ID.
source_workspace_name	No	String	Source workspace name.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
code	Integer	Error code. The value 0 indicates a success. Other values indicate an error.
data	Integer	Returned data.
msg	String	Returned status information.

Example Requests

{
  "consumption_type" : 0,
  "dataspace_id" : "00000000-0000-0000-0000-000000000000",
  "dataspace_name" : "isap-cloudlogs-00000000-0000-0000-0000-000000000000",
  "domain_id" : "00000000000000000000000000000000",
  "pipe_id" : "00000000-0000-0000-0000-000000000000",
  "pipe_name" : "sec-dbss-alarm",
  "project_id" : "00000000000000000000000000000000",
  "shipper_destination" : {
    "data_param" : "{}",
    "destination_dataspace" : "00000000-0000-0000-0000-000000000000",
    "destination_dataspace_name" : "isap-cloudlogs-00000000-0000-0000-0000-000000000000",
    "destination_identity_role" : "pipe-strategy",
    "destination_pipe" : "00000000-0000-0000-0000-000000000000",
    "destination_pipe_name" : "sec-dbss-alarm",
    "destination_region" : "cn-southwest-2",
    "destination_shipper_type" : 0,
    "destination_workspace" : "00000000-0000-0000-0000-000000000000",
    "destination_workspace_name" : "Workspace name."
  },
  "shipper_name" : "shipperName",
  "shipper_source" : {
    "region" : "cn-southwest-2",
    "source_dataspace" : "00000000-0000-0000-0000-000000000000",
    "source_dataspace_name" : "isap-cloudlogs-00000000-0000-0000-0000-000000000000",
    "source_identity_role" : "pipe-strategy",
    "source_pipe" : "00000000-0000-0000-0000-000000000000",
    "source_pipe_name" : "sec-dbss-alarm",
    "source_type" : 0,
    "source_workspace" : "00000000-0000-0000-0000-000000000000",
    "source_workspace_name" : "Workspace name."
  },
  "version" : "v1",
  "workspace_id" : "00000000-0000-0000-0000-000000000000",
  "workspace_name" : "Workspace name."
}