文档首页/ 安全云脑 SecMaster/ API参考/ API V2/ 操作连接管理/ 新建操作连接
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建操作连接

功能介绍

新建操作连接

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释:

工作空间ID

取值范围:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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

操作连接的名称

description

否

String

操作连接的描述信息

component_id

是

String

操作连接所属的插件id

component_version_id

是

String

操作连接所属的插件版本id

config

是

String

具体的操作连接配置字符串，根据插件的操作连接schema配置对应字段值

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

code

String

Error code.

message

String

Error description.

data

AssetInfoResponseBody object

操作连接信息参数对象
表5 AssetInfoResponseBody

参数

参数类型

描述

id

String

The id, display only

project_id

String

Project id value

workspace_id

String

workspace id

name

String

The name, display only

component_id

String

Component id

component_name

String

Component name

component_version_id

String

Component version id

type

String

Type of assets(datasource, action_target)

status

String

Status of assets. SUCCESS, FAILED

config

String

config

description

String

The description, display only

enabled

Boolean

Enabled, false for disenabled, true for enabled

create_time

String

Create time

creator_id

String

Creator id value

creator_name

String

Creator name value

update_time

String

Update time

modifier_id

String

Modifier id value

modifier_name

String

Modifier name value

defense_type

String

下发应急策略时的所属的防线分类

target_project_id

String

下发应急策略时的IAM项目ID

target_project_name

String

下发应急策略时的IAM项目名称

target_enterprise_id

String

下发应急策略时的企业项目ID

target_enterprise_name

String

下发应急策略时的企业项目名称

region_id

String

下发应急策略时的区域ID

region_name

String

下发应急策略时的区域名称

状态码：400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

状态码：500

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

description

{
  "name" : "test_create",
  "description" : "description",
  "component_id" : "ad93ecc6-1723-4c2c-9976-9eb0182c2d18",
  "component_version_id" : "33fd1b37-1f39-4230-86c6-2d119e9f4fac",
  "config" : "{\"password\":\"******\",\"kafkaAddr\":\"aaa\",\"keyStorePassword\":\"******\",\"userName\":\"bbb\"}"
}

响应示例

状态码：200

请求成功

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码。

父主题： 操作连接管理

相关文档