文档首页/ 数据安全中心 DSC/ API参考/ API/ 识别模板/ 查询模板规则关联关系 - ListTemplateScanRules
更新时间:2026-11-13 GMT+08:00
分享

查询模板规则关联关系 - ListTemplateScanRules

功能介绍

功能介绍:查询识别模板与识别规则的关联关系列表,支持多条件过滤。 关键参数说明:支持offset/limit分页、classification_ids分类过滤、security_level_ids安全等级过滤、is_used启用状态过滤、rule_name规则名称过滤。 返回值说明:返回关联总数及规则关联列表(含模板、分类、安全等级、规则信息)。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/scan-templates/{template_id}/scan-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

template_id

是

String

参数解释:

模板ID,标识需要查询规则关联关系的识别模板,可通过调用查询模板列表接口获取

约束限制:

符合正则匹配"^[a-zA-Z0-9\-]{10,64}$"

取值范围:

长度10~64个字符

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

classification_ids

否

Array of strings

参数解释:

分类ID列表,用于按分类过滤规则关联关系,数组元素个数最多100个

约束限制:

符合正则匹配"^[a-zA-Z0-9\-]{10,64}$"

取值范围:

数组类型

默认取值:

不涉及

security_level_ids

否

Array of strings

参数解释:

安全级别ID列表,用于按安全级别过滤规则关联关系,数组元素个数最多100个

约束限制:

符合正则匹配"^[a-zA-Z0-9\-]{10,64}$"

取值范围:

数组类型

默认取值:

不涉及

is_used

否

Boolean

参数解释:

是否已用

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

rule_name

否

String

参数解释:

规则名称

约束限制:

符合正则匹配"^[\u4E00-\u9FA5\uF900-\uFA2D()()-_\w\- ]{1,255}$"

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

template_rules_list

Array of TemplateRule objects

参数解释:

模板规则列表

取值范围:

不涉及

total

Long

参数解释:

总记录数

取值范围:

不涉及

表5 TemplateRule

参数

参数类型

描述

project_id

String

参数解释:

项目ID

取值范围:

不涉及

template_id

String

参数解释:

模板ID

取值范围:

不涉及

classification_id

String

参数解释:

分类ID,标识规则关联关系对应的数据分类

取值范围:

字符串类型

security_level_id

String

参数解释:

安全级别ID,标识规则关联关系对应的安全等级

取值范围:

字符串类型

security_level_name

String

参数解释:

安全等级名称

取值范围:

不涉及

security_level_color

Integer

参数解释:

安全等级颜色,为颜色编码整数值,标识安全等级对应的显示颜色

取值范围:

整数值

rule_id

String

参数解释:

规则ID

取值范围:

不涉及

rule_name

String

参数解释:

规则名称

取值范围:

不涉及

is_used

Boolean

参数解释:

是否启用

取值范围:

true-是,false-否

rule_description

String

参数解释:

规则描述

取值范围:

不涉及

请求示例

查询模板规则关联关系

/v1/2b31ed520aabbccddeedb6e571234567/scan-templates/7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b/scan-rules

响应示例

状态码:200

{
  "template_rules_list" : [ {
    "project_id" : "2d52d09a-f0d3-4c1a-86b4-fc7e435e9c7a",
    "template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
    "classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
    "security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
    "security_level_name" : "scan-rule-01",
    "security_level_color" : 3,
    "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
    "rule_name" : "classification-rule-01",
    "is_used" : true,
    "rule_description" : "scan-rule示例描述"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档