更新时间:2025-08-30 GMT+08:00
分享

列表采集连接

功能介绍

列表采集连接

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/workspaces/{workspace_id}/collector/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

connection_type

String

参数解释:

连接类型

  • FILTER 过滤

  • INPUT 输入

  • OUTPUT 输出

约束限制

不涉及

取值范围:

  • FILTER

  • INPUT

  • OUTPUT

默认值

不涉及

title

String

标题

description

String

相关描述

offset

Integer

Offset

limit

Integer

Limit

sort_key

String

Sort Key

sort_dir

String

参数解释:

目录排序

  • asc 升序排列

  • desc 降序排列

约束限制

不涉及

取值范围:

  • asc

  • desc

默认值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

计数

records

Array of Connection objects

相关描述信息

表5 Connection

参数

参数类型

描述

connection_id

String

UUID

module_id

String

UUID

template_title

String

相关标题

title

String

相关标题

channel_refer_count

Integer

数值

info

String

描述信息

description

String

描述信息

connection_type

String

参数解释:

连接类型

  • FILTER 过滤

  • INPUT 输入

  • OUTPUT 输出

约束限制

不涉及

取值范围:

  • FILTER

  • INPUT

  • OUTPUT

默认值

不涉及

请求示例

响应示例

状态码

状态码

描述

200

Success

错误码

请参见错误码

相关文档