文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 数据投递/ 获取投递授权信息列表 - ListShipperAuthorizations
更新时间:2025-12-12 GMT+08:00
分享

获取投递授权信息列表 - ListShipperAuthorizations

功能介绍

获取投递授权信息列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers/authorizations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

source_region

String

数据源

destination_shipper_type

String

目的投递类型

shipper_status

String

数据投递状态

auth_status

String

授权状态

limit

Long

每页数量

offset

Long

第几页

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

Integer

错误码,0表示成功,其他值表示错误

data

data object

结果数据

msg

String

返回的状态信息,用于描述当前请求的结果

表5 data

参数

参数类型

描述

data

Array of data objects

结果数据

limit

Integer

每页显示的记录数

offset

Integer

当前页的起始偏移量

total

Integer

总记录数

表6 data

参数

参数类型

描述

authorize_status

Integer

授权状态,0-已授权,1-未授权,2-拒绝授权

data_source_query

String

数据源查询字符串,表示数据源的路径

data_type

Integer

数据类型,具体含义根据业务定义

dataspace

String

数据空间ID,唯一标识

id

Integer

唯一标识ID

pipe

String

管道ID,唯一标识

region

String

地域信息

request_time

Long

请求时间,单位为毫秒的时间戳

handler_time

Long

授权时间,单位为毫秒的时间戳

run_status

Integer

运行状态,具体含义根据业务定义

shipper_id

String

船运ID,唯一标识

shipper_name

String

船运名称

workspace

String

工作空间ID,唯一标识

请求示例

响应示例

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档