文档首页/ 数据安全中心 DSC/ API参考/ API说明/ 查询规则基础信息列表/ 查询规则基础信息列表 - ShowScanRulesResponse
更新时间：2025-11-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询规则基础信息列表 - ShowScanRulesResponse

功能介绍

查询规则基础信息列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/scan-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，用于标识具体的项目。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

scan_rules_list

Array of ShowScanRuleBasicInfo objects

规则列表，包含每个规则的详细信息。

total

Long

规则总数，表示规则的总数。
表3 ShowScanRuleBasicInfo

参数

参数类型

描述

category

String

规则类别，用于区分内置规则（BUILT_IN）和用户自定义规则（BUILT_SELF）。

project_id

String

项目ID，用于标识具体的项目。

rule_desc

String

规则描述，对规则功能的简要说明。

rule_id

String

规则ID，用于唯一标识该规则。

rule_name

String

规则名称，用于标识和管理规则。

rule_type

String

规则类型，包括关键字（KEYWORD）、正则表达式（REGEX）或自然语言（NLP）。

请求示例

无

响应示例

无

状态码

状态码

描述

200

请求成功，返回扫描规则的详细信息。

401

未授权，用户未登录或令牌无效。

403

无权限访问该资源。

404

未找到指定的规则。

错误码

请参见错误码。

相关文档