文档首页/ 数据安全中心 DSC/ API参考/ API/ 识别规则/ 获取单条规则详细信息 - ShowRuleDetail
更新时间:2026-10-20 GMT+08:00
分享

获取单条规则详细信息 - ShowRuleDetail

功能介绍

功能介绍:获取单条识别规则的详细信息。 关键参数说明:通过rule_id定位规则。 返回值说明:返回规则详细信息(含分组、是否可删除等)。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/sdg/server/scan/rules/{rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识用户在数据安全中心控制台中创建的项目

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

rule_id

是

String

参数解释:

规则ID,标识需要查询详细信息的识别规则,可通过调用查询规则列表接口获取

约束限制:

不涉及

取值范围:

长度1~64个字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

rule_name

String

参数解释:

规则名称

取值范围:

不涉及

rule_type

String

参数解释:

规则类型

取值范围:

  • KEYWORD-关键字

  • REGEX-正则

  • NLP-自然语言处理

logic_operator

String

参数解释:

逻辑操作符

取值范围:

AND-且,OR-或

rule_content

String

参数解释:

规则内容

取值范围:

不涉及

risk_level

Integer

参数解释:

规则风险等级,标识规则识别结果的风险程度

取值范围:

整数

rule_desc

String

参数解释:

规则描述

取值范围:

不涉及

category

String

参数解释:

类别

取值范围:

  • BUILT_IN-内置

  • BUILT_IN_COPY-内置复制

  • BUILT_SELF-自定义

selected

Boolean

参数解释:

已选

取值范围:

true-是,false-否

group_names

String

参数解释:

分组名称列表

取值范围:

不涉及

delete_allowed

Boolean

参数解释:

允许删除

取值范围:

true-是,false-否

min_match

Integer

参数解释:

最小匹配数,即触发规则需要匹配到敏感数据的最小次数

取值范围:

0~2147483647之间的整数

请求示例

获取单条规则详细信息

/v1/2b31ed520aabbccddeedb6e5712345678/sdg/server/scan/rules/4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e

响应示例

状态码:200

{
  "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
  "rule_name" : "classification-rule-01",
  "rule_type" : "KEYWORD",
  "logic_operator" : "AND",
  "rule_content" : "phone_number",
  "risk_level" : 3,
  "rule_desc" : "classification-rule-01",
  "category" : "BUILT_IN",
  "selected" : true,
  "group_names" : "rule-group-01",
  "delete_allowed" : true,
  "min_match" : 100
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档