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

创建连接器 - CreateConnector

功能介绍

创建连接器,配置源产品和目的产品信息、连接参数和连接列表

调用方法

请参见如何调用API。

授权信息

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

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/connectors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

是

String

参数解释:

语言,参考值:zh-cn、en-us

约束限制:

不涉及

取值范围:

zh-cn:中文环境 en-us:英文环境

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

是

String

参数解释:

内容类型 - application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释:

连接器名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

zh_name

是

String

参数解释:

连接器中文名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

en_name

是

String

参数解释:

连接器英文名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

否

String

参数解释:

连接器描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

zh_description

否

String

参数解释:

连接器中文描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

en_description

否

String

参数解释:

连接器英文描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tags

否

String

参数解释:

标签

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

runner_type

是

String

参数解释:

连接器类型/运行器类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

runner_name

否

String

参数解释:

执行引擎实例名称,必须以字母开头,以字母或数字结尾,仅包含字母、数字、下划线、中划线,长度不超过60

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

connector_type

否

String

参数解释:

来源类型(SYSTEM/CUSTOM,可选,默认CUSTOM)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

region_id

是

String

参数解释:

区域ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

domain_id

是

String

参数解释:

账号ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

src_provider_id

是

String

参数解释:

源产品ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

src_provider_name

是

String

参数解释:

源产品名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

src_desc

否

String

参数解释:

源产品描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dst_provider_id

是

String

参数解释:

目标产品ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dst_provider_name

是

String

参数解释:

目标产品名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dst_desc

否

String

参数解释:

目标产品描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

attachment_id

否

String

参数解释:

附件ID(函数zip包文件)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

connection_params

否

String

参数解释:

连接参数(JSON格式,可选)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

datalinks

否

Array of DatalinkItem objects

参数解释:

连接器连接列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

version

否

String

参数解释:

版本号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

meta_info

否

String

参数解释:

元数据信息(JSON格式)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

trigger_info

否

String

参数解释:

触发器信息(JSON格式)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

deploy_info

否

String

参数解释:

部署信息(JSON格式)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

creator_id

是

String

参数解释:

创建者ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

creator_name

是

String

参数解释:

创建者名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 DatalinkItem

参数

是否必选

参数类型

描述

name

是

String

参数解释:

连接器连接名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

src_asset_id

否

String

参数解释:

源端凭据ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

src_scope

否

String

参数解释:

源端范围

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dst_asset_id

否

String

参数解释:

目的端凭据ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dst_scope

否

String

参数解释:

目的端范围

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

src_dataset_desc

否

String

参数解释:

源端数据集描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dst_dataset_desc

否

String

参数解释:

目的端数据集描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

extend_params

否

String

参数解释:

运行时参数(JSON格式)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

请求描述

取值范围:

不涉及

data

ConnectorDetail object

参数解释:

连接器详情

取值范围:

不涉及

表6 ConnectorDetail

参数

参数类型

描述

id

String

参数解释:

连接器ID

取值范围:

不涉及

is_deleted

Boolean

参数解释:

是否删除

取值范围:

  • true:是

  • false:否

name

String

参数解释:

连接器名称

取值范围:

不涉及

description

String

参数解释:

连接器描述

取值范围:

不涉及

domain_id

String

参数解释:

workspace归属的账号ID

取值范围:

不涉及

domain_name

String

参数解释:

workspace归属的账号名称

取值范围:

不涉及

region_id

String

参数解释:

workspace归属的账号名称的region_id

取值范围:

不涉及

region_name

String

参数解释:

workspace归属的账号名称的region_name

取值范围:

不涉及

project_id

String

参数解释:

workspace归属的项目id

取值范围:

不涉及

workspace_id

String

参数解释:

当前的工作空间id

取值范围:

不涉及

runner_type

String

参数解释:

连接器类型

取值范围:

不涉及

src_provider_id

String

参数解释:

源产品唯一标识

取值范围:

不涉及

src_provider_name

String

参数解释:

源产品名称

取值范围:

不涉及

src_desc

String

参数解释:

源产品描述

取值范围:

不涉及

dst_provider_id

String

参数解释:

目的产品唯一标识

取值范围:

不涉及

dst_provider_name

String

参数解释:

目的产品名称

取值范围:

不涉及

dst_desc

String

参数解释:

目的产品描述

取值范围:

不涉及

create_time

String

参数解释:

记录时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

取值范围:

不涉及

update_time

String

参数解释:

更新时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为告警发生时区,无法解析时区的时间,默认时区填东八区

取值范围:

不涉及

tags

String

参数解释:

标签,连接器标签,当前内置连接器默认为资产,支持自定义

取值范围:

不涉及

run_type

String

参数解释:

运行器类型

取值范围:

不涉及

attachment_id

String

参数解释:

附件ID

取值范围:

不涉及

connection_params

String

参数解释:

连接参数(JSON格式,可选)

取值范围:

不涉及

creator_id

String

参数解释:

创建者ID

取值范围:

不涉及

creator_name

String

参数解释:

创建者名称

取值范围:

不涉及

modifier_id

String

参数解释:

修改者ID

取值范围:

不涉及

modifier_name

String

参数解释:

修改者名称

取值范围:

不涉及

version

String

参数解释:

连接器的版本,v25.8.0,当前版本固定为latest, 有新版本时,将上一个版本发布为上个版本号

取值范围:

不涉及

meta_info

String

参数解释:

连接器元数据,元数据,如果没有设置,则默认为构建产物中的yaml配置,如果有设置,则更新设置的属性值。参考:functiongraph,meta_data对象

取值范围:

不涉及

trigger_info

String

参数解释:

触发器信息,像config连接器需要dms kafka触发器,像定义的timer触发器, 参考:functiongraph trigger

取值范围:

不涉及

deploy_info

String

参数解释:

部署信息,Json结构,调用时根据部署信息进行联动。例如是FG时, 参考:fg function对象

取值范围:

不涉及

deploy_status

String

参数解释:

连接器部署状态

取值范围:

  • NOT_DEPLOYED:未部署

  • DEPLOYING:部署中

  • DEPLOYED:已部署

  • UNINSTALLING:卸载中

  • INSTALL_FAILED:安装失败

  • UNINSTALL_FAILED:卸载失败

run_status

String

参数解释:

连接器实例的运行状态

取值范围:

  • NORMAL:正常

  • ABNORMAL:异常

  • STOPPED:未运行

zh_name

String

参数解释:

连接器中文名称

取值范围:

不涉及

en_name

String

参数解释:

连接器英文名称

取值范围:

不涉及

zh_description

String

参数解释:

连接器中文描述

取值范围:

不涉及

en_description

String

参数解释:

连接器英文描述

取值范围:

不涉及

runner_id

String

参数解释:

执行引擎实例ID(如FunctionGraph函数URN)

取值范围:

不涉及

runner_name

String

参数解释:

执行引擎实例名称

取值范围:

不涉及

connector_type

String

参数解释:

来源类型(SYSTEM/CUSTOM)

取值范围:

不涉及

is_built_in

Boolean

参数解释:

是否内置

取值范围:

  • true:是

  • false:否

datalinks

Array of DataLink objects

参数解释:

连接器连接列表

取值范围:

不涉及

状态码:400

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

请求响应码

取值范围:

不涉及

message

String

参数解释:

请求描述

取值范围:

不涉及

请求示例

创建连接器的请求样例

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/connectors

{
  "name" : "connector-001",
  "zh_name" : "连接器1",
  "en_name" : "Connector1",
  "description" : "连接器描述",
  "zh_description" : "连接器中文描述",
  "en_description" : "Connector description",
  "tags" : "内部",
  "runner_type" : "FunctionGraph",
  "runner_name" : "connector-runner-001",
  "connector_type" : "CUSTOM",
  "region_id" : "cn-north-4",
  "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca622",
  "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca623",
  "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624",
  "src_provider_id" : "909494e3-558e-46b6-a9eb-07a8e18ca626",
  "src_provider_name" : "A云WAF",
  "src_desc" : "A云WAF产品",
  "dst_provider_id" : "909494e3-558e-46b6-a9eb-07a8e18ca628",
  "dst_provider_name" : "B云SecMaster",
  "dst_desc" : "B云安全云脑产品",
  "attachment_id" : "909494e3-558e-46b6-a9eb-07a8e18ca629",
  "connection_params" : "{\"timeout\": 30, \"retry_count\": 3}",
  "datalinks" : [ {
    "name" : "连接1",
    "src_asset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca630",
    "dst_asset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca631"
  }, {
    "name" : "连接2",
    "src_asset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca630",
    "dst_asset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca631"
  } ],
  "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca632",
  "creator_name" : "用户1"
}

响应示例

状态码:200

{
  "code" : "SecMaster.00000000",
  "message" : "Success",
  "data" : {
    "id" : "cae09c05-2e17-4ccb-96a6-b2edeb9f5394",
    "name" : "connector-001",
    "deploy_status" : "NOT_DEPLOYED",
    "run_status" : "STOPPED",
    "create_time" : "2023-02-27T20:28:53.001+08:00",
    "update_time" : "2023-02-27T20:28:53.001+08:00"
  }
}

状态码

状态码

描述

200

创建连接器返回body体

400

响应错误返回对象

错误码

请参见错误码。

相关文档