创建数据投递 - CreateShipper
功能介绍
创建数据投递
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/shippers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
consumption_type |
否 |
Integer |
消费类型，0-实时 1-调度 |
|
dataspace_id |
否 |
String |
数据空间ID |
|
dataspace_name |
否 |
String |
数据空间名称 |
|
domain_id |
否 |
String |
租户ID |
|
pipe_id |
否 |
String |
管道ID |
|
pipe_name |
否 |
String |
管道名称 |
|
project_id |
否 |
String |
项目ID |
|
shipper_destination |
否 |
shipper_destination object |
投递目标 |
|
shipper_name |
否 |
String |
投递名称 |
|
shipper_source |
否 |
shipper_source object |
投递源 |
|
version |
否 |
String |
版本信息 |
|
workspace_id |
否 |
String |
工作区ID |
|
workspace_name |
否 |
String |
工作区名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data_param |
否 |
String |
数据参数 |
|
destination_dataspace |
否 |
String |
目标数据空间ID |
|
destination_dataspace_name |
否 |
String |
目标数据空间名称 |
|
destination_identity_role |
否 |
String |
目标身份角色 |
|
destination_pipe |
否 |
String |
目标管道ID |
|
destination_pipe_name |
否 |
String |
目标管道名称 |
|
destination_region |
否 |
String |
目标区域信息 |
|
destination_shipper_type |
否 |
Integer |
目标投递类型 |
|
destination_workspace |
否 |
String |
目标工作区ID |
|
destination_workspace_name |
否 |
String |
目标工作区名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
region |
否 |
String |
区域信息 |
|
source_dataspace |
否 |
String |
源数据空间ID |
|
source_dataspace_name |
否 |
String |
源数据空间名称 |
|
source_identity_role |
否 |
String |
源身份角色 |
|
source_pipe |
否 |
String |
源管道ID |
|
source_pipe_name |
否 |
String |
源管道名称 |
|
source_type |
否 |
Integer |
源类型 |
|
source_workspace |
否 |
String |
源工作区ID |
|
source_workspace_name |
否 |
String |
源工作区名称 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
Integer |
错误码，0表示成功，其他值表示错误 |
|
data |
Integer |
返回的数据 |
|
msg |
String |
返回的状态信息 |
请求示例
{
"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" : "空间名"
},
"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" : "空间名"
},
"version" : "v1",
"workspace_id" : "00000000-0000-0000-0000-000000000000",
"workspace_name" : "空间名"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
错误码
请参见错误码。
