投递规则详情 - ShowShipper
功能介绍
投递规则详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers/{shipper_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
shipper_id |
是 |
String |
投递ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
Integer |
状态码 |
|
data |
data object |
投递数据 |
|
msg |
String |
响应消息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
consumption_type |
Integer |
消费类型 |
|
create_time |
Integer |
创建时间(时间戳) |
|
dataspace_id |
String |
数据空间ID |
|
dataspace_name |
String |
数据空间名称 |
|
domain_id |
String |
域ID |
|
id |
Integer |
管道ID |
|
pipe_id |
String |
管道ID |
|
pipe_name |
String |
管道名称 |
|
project_id |
String |
项目ID |
|
shipper_destination |
shipper_destination object |
投递目的 |
|
shipper_id |
String |
发货人ID |
|
shipper_name |
String |
发货人名称 |
|
shipper_source |
shipper_source object |
投递源 |
|
status |
Integer |
状态 |
|
update_time |
Integer |
更新时间(时间戳) |
|
version |
String |
版本 |
|
workspace_id |
String |
工作区ID |
|
workspace_name |
String |
工作区名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_param |
String |
目的地参数 |
|
data_type |
Integer |
数据类型 |
|
dataspace |
String |
数据空间 |
|
dataspace_name |
String |
数据空间名称 |
|
destination_info |
String |
目的地信息 |
|
id |
Integer |
目的地ID |
|
identity |
String |
标识 |
|
pipe |
String |
管道ID |
|
pipe_name |
String |
管道名称 |
|
region |
String |
区域 |
|
type |
Integer |
类型 |
|
workspace |
String |
工作区ID |
|
workspace_name |
String |
工作区名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_type |
Integer |
数据类型 |
|
dataspace |
String |
数据空间 |
|
dataspace_name |
String |
数据空间名称 |
|
id |
Integer |
源ID |
|
identity |
String |
标识 |
|
pipe |
String |
管道ID |
|
pipe_name |
String |
管道名称 |
|
region |
String |
区域 |
|
type |
Integer |
类型 |
|
workspace |
String |
工作区ID |
|
workspace_name |
String |
工作区名称 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
错误响应 |
错误码
请参见错误码。