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

操作连接列表查询接口 - ListAssets

功能介绍

操作连接列表查询接口

调用方法

请参见如何调用API

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

Integer

参数解释:

数据量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

连接名称

component_name

String

插件名称

creator_name

String

创建人

modifier_name

String

修改人

description

String

描述

create_start_time

String

创建起始时间

create_end_time

String

创建结束时间

update_start_time

String

修改起始时间

update_end_time

String

修改结束时间

is_defense_type

Boolean

是否用于应急策略的操作连接

请求参数

表3 请求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

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

total

Integer

数据总量

asset

Array of AssetInfoResponseBody objects

操作连接响应体

表5 AssetInfoResponseBody

参数

参数类型

描述

id

String

操作连接ID

project_id

String

项目ID

workspace_id

String

空间ID

name

String

操作连接名称

component_id

String

操作连接所属的插件id

component_name

String

操作连接所属的插件id名称

component_version_id

String

插件版本ID

type

String

操作连接类型

status

String

操作连接状态(SUCCESS/FAILED)

config

String

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

description

String

操作连接描述

enabled

Boolean

是否启用

create_time

String

创建时间

creator_id

String

创建者ID

creator_name

String

创建者名称

update_time

String

更新时间

modifier_id

String

更新者ID

modifier_name

String

更新者名称

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

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

can_be_deleted

Boolean

是否可删除,操作连接有流程在使用时,返回false

状态码:400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码:200

请求成功

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码

相关文档