文档首页/ 安全云脑 SecMaster/ API参考/ API V2/ 租户采集/ 列出采集模块规则
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

列出采集模块规则

功能介绍

列出采集模块规则

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/collector/module-templates/restriction

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及w

默认取值：

不涉及

workspace_id

是

String

工作空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

template_ids

是

Array of strings

相关描述信息

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ShowTemplateFields objects

模板描述信息数组
表5 ShowTemplateFields

参数

参数类型

描述

template_id

String

UUID

fields

Array of TemplateField objects

相关描述信息
表6 TemplateField

参数

参数类型

描述

template_field_id

String

UUID

title

String

相关标题

type

String

规则类型

name

String

规则名称

description

String

描述信息

default_value

String

默认值

example

String

示例

required

Boolean

是否必填

restrictions

Array of Restriction objects

相关描述信息
表7 Restriction

参数

参数类型

描述

title

String

相关标题

type

String

规则类型

value

String

规则名称

logic

Boolean

逻辑条件

请求示例

无

响应示例

无

状态码

状态码

描述

200

Success

错误码

请参见错误码。

父主题： 租户采集

相关文档