文档首页/ 数据安全中心 DSC/ API参考/ API/ 识别配置/ 根据规则ID查询规则详细信息 - ShowScanRule
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据规则ID查询规则详细信息 - ShowScanRule

功能介绍

功能介绍：根据规则ID查询规则详细信息

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/scan-rules/{rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32。

默认取值：

不涉及

rule_id

是

String

参数解释：

规则ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

rule_id

String

参数解释：

规则ID

取值范围：

不涉及

rule_name

String

参数解释：

规则名称

取值范围：

不涉及

rule_desc

String

参数解释：

规则描述

取值范围：

不涉及

rule_type

String

参数解释：

扫描规则响应类型

取值范围：

不涉及

category

String

参数解释：

类别

取值范围：

不涉及

content

Array of ScanRuleContentInfo objects

参数解释：

规则内容

取值范围：

不涉及

templates

Array of ShowRuleTemplateInfo objects

参数解释：

规则模板列表

取值范围：

不涉及

logic_operator

String

参数解释：

逻辑操作符

取值范围：

AND-且，OR-或

min_match

Integer

参数解释：

最小匹配

取值范围：

不涉及

match_rate

Integer

参数解释：

匹配率

取值范围：

不涉及

create_time

Long

参数解释：

创建时间

取值范围：

不涉及

update_time

Long

参数解释：

更新时间

取值范围：

不涉及

has_whitelist

Boolean

参数解释：

是否有白名单

取值范围：

true-是，false-否

whitelist_content

Array of ScanRuleContentInfo objects

参数解释：

白名单内容

取值范围：

不涉及

whitelist_rule_type

String

参数解释：

白名单规则类型

取值范围：

不涉及

whitelist_logic_operator

String

参数解释：

白名单逻辑操作符

取值范围：

AND-且，OR-或

whitelist_min_match

Integer

参数解释：

白名单最小匹配

取值范围：

不涉及

whitelist_match_rate

Integer

参数解释：

白名单匹配比率

取值范围：

不涉及
表4 ShowRuleTemplateInfo

参数

参数类型

描述

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

rule_id

String

参数解释：

规则ID

取值范围：

不涉及

template_id

String

参数解释：

模板ID

取值范围：

不涉及

template_name

String

参数解释：

模板名称

取值范围：

不涉及

classification_id

String

参数解释：

规则模板信息ID

取值范围：

不涉及

classification_name

String

参数解释：

规则模板信息名称

取值范围：

不涉及

security_level_id

String

参数解释：

规则模板信息ID

取值范围：

不涉及

security_level_color

Integer

参数解释：

安全等级颜色

取值范围：

不涉及

security_level_name

String

参数解释：

安全等级名称

取值范围：

不涉及

is_used

Boolean

参数解释：

是否启用

取值范围：

true-是，false-否
表5 ScanRuleContentInfo

参数

参数类型

描述

location

String

参数解释：

规则位置

取值范围：

不涉及

effective_mode

String

参数解释：

扫描规则内容信息模式

取值范围：

不涉及

rule_content

String

参数解释：

规则内容

取值范围：

不涉及

请求示例

根据规则ID查询规则详细信息

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/scan-rules/{rule_id}

响应示例

状态码：200

{
  "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
  "rule_name" : "classification-rule-01",
  "rule_desc" : "scan-rule-01",
  "rule_type" : "KEYWORD",
  "category" : "BUILT_IN",
  "content" : [ {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  }, {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  } ],
  "templates" : [ {
    "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
    "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
    "template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
    "template_name" : "scan-template-01",
    "classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
    "classification_name" : "scan-rule-01",
    "security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
    "security_level_color" : 3,
    "security_level_name" : "scan-rule-01",
    "is_used" : true
  }, {
    "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
    "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
    "template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
    "template_name" : "scan-template-01",
    "classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
    "classification_name" : "scan-rule-01",
    "security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
    "security_level_color" : 3,
    "security_level_name" : "scan-rule-01",
    "is_used" : true
  } ],
  "logic_operator" : "scan-rule-01",
  "min_match" : 100,
  "match_rate" : 100,
  "create_time" : 1700000000000,
  "update_time" : 1700000000000,
  "has_whitelist" : true,
  "whitelist_content" : [ {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  }, {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  } ],
  "whitelist_rule_type" : "OBS",
  "whitelist_logic_operator" : "scan-rule-01",
  "whitelist_min_match" : 100,
  "whitelist_match_rate" : 100
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 识别配置

相关文档