查询投递信息 - ListShippers
功能介绍
查询投递信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataspace_id |
否 |
String |
数据空间ID |
|
pipe_id |
是 |
String |
管道ID |
|
shipper_name |
否 |
String |
投递名称 |
|
shipper_source_region |
否 |
String |
数据源区域 |
|
shipper_source_strategy |
否 |
String |
数据源消费策略 |
|
shipper_consumption_type |
否 |
String |
数据源消费类型 |
|
destination_shipper_type |
否 |
String |
目的投递类型 |
|
shipper_status |
否 |
String |
数据投递状态 |
|
create_time |
否 |
String |
创建时间 |
|
limit |
否 |
Long |
每页数量 |
|
offset |
否 |
Long |
第几页 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
Integer |
错误码，0表示成功，其他值表示错误 |
|
data |
ApiResponseData object |
数据信息 |
|
msg |
String |
返回的状态信息，用于描述当前请求的结果 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of ApiResponseDataItem objects |
结果数据 |
|
limit |
Integer |
每页显示的记录数 |
|
offset |
Integer |
当前页的起始偏移量 |
|
total |
Integer |
总记录数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
ShipperDestination object |
投递目的 |
|
shipper_id |
String |
船运ID，唯一标识 |
|
shipper_name |
String |
船运名称 |
|
shipper_source |
ShipperSource object |
投递源 |
|
status |
Integer |
状态码，具体含义根据业务定义 |
|
update_time |
Integer |
更新时间，单位为毫秒的时间戳 |
|
version |
String |
版本信息 |
|
workspace_id |
String |
工作区ID，唯一标识 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_param |
String |
数据参数，通常为JSON格式 |
|
data_type |
Integer |
数据类型，具体含义根据业务定义 |
|
dataspace |
String |
数据空间ID |
|
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 |
工作空间名称 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
错误码
请参见错误码。
