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

列出目录分组

功能介绍

列出目录分组

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/directories

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

category

String

参数解释:

目录类型

  • TABLE 表

  • PIPE 管道

  • RETRIEVE_SCRIPT 检索脚本

  • ANALYSIS_SCRIPT 分析脚本

  • DATA_TRANSFORMATION 数据加工

  • ALERT_RULE 告警规则

约束限制

不涉及

取值范围:

  • TABLE

  • PIPE

  • RETRIEVE_SCRIPT

  • ANALYSIS_SCRIPT

  • DATA_TRANSFORMATION

  • ALERT_RULE

默认值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

directories

Array of strings

目录列表

directory_i18ns

Array of DirectoryI18N objects

目录I18N列表

表5 DirectoryI18N

参数

参数类型

描述

directory

String

directory 目录分组

directory_en

String

directory 目录分组

directory_fr

String

directory 目录分组

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

Response of list directories

400

Error response

错误码

请参见错误码

相关文档