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

列出代码片段

功能介绍

列出代码片段

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/code-segments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

code_segment_id

String

代码片段 ID

code_segment_name

String

代码片段名称

offset

Long

参数解释:

偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

Long

参数解释:

查询数据限制

取值范围:

0-1000

默认取值:

不涉及

sort_key

String

按照属性排序。

sort_dir

String

排序顺序,支持 ASCDESC

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

计数

records

Array of CodeSegment objects

代码片段

表5 CodeSegment

参数

参数类型

描述

code_segment_id

String

UUID

project_id

String

项目ID

workspace_id

String

工作空间ID

code_negment_name

String

代码段名称

description

String

代码段描述信息

code

String

代码片段

create_by

String

Iam用户ID

create_time

Integer

毫秒时间戳

update_by

String

Iam用户ID

update_time

Integer

毫秒时间戳

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

成功

400

Error response

错误码

请参见错误码

相关文档