# 查询规则 - ShowServerRules #### 功能介绍 功能介绍：查询识别规则列表，按规则类型返回匹配的识别规则，用于脱敏策略配置。 #### 接口约束 - 无特殊约束。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/sdg/server/rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，长度为32个字符，满足正则匹配"\^\[a-z0-9\]{32}$" **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_id | 否 | String | **参数解释：** 规则请求ID **约束限制：** 最大长度64字符 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rules | Array of [ResponseBodyRule] objects | **参数解释：** 识别规则列表，数组中的每个元素为一条识别规则记录 **取值范围：** 不涉及 | | total | Integer | **参数解释：** 总记录数 **取值范围：** 不涉及 | 表5ResponseBodyRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rule_id | String | **参数解释：** 规则ID **取值范围：** 不涉及 | | rule_name | String | **参数解释：** 规则名称 **取值范围：** 不涉及 | | rule_type | String | **参数解释：** 规则类型 **取值范围：** - KEYWORD-关键字匹配 - REGEX-正则表达式匹配 - NLP-自然语言处理匹配 | | logic_operator | String | **参数解释：** 规则逻辑运算符 **取值范围：** - AND-与 - OR-或 | | rule_content | String | **参数解释：** 规则内容表达式 **取值范围：** 不涉及 | | risk_level | Integer | **参数解释：** 规则等级 **取值范围：** - HIGH-高风险 - MIDDLE-中风险 - LOW-低风险 - UNKNOW-未知 - IGNORED-已忽略 - INIT-初始化 | | 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 | **参数解释：** 最小匹配次数 **取值范围：** 不涉及 | #### 请求示例 查询规则请求体 ``` { "group_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" } ``` #### 响应示例 **状态码：200** ``` { "rules" : [ { "rule_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "rule_name" : "手机号识别规则", "rule_type" : "KEYWORD", "logic_operator" : "AND", "rule_content" : "1[3-9]\\d{9}", "risk_level" : 1, "rule_desc" : "识别客户手机号码", "category" : "BUILT_IN", "selected" : true, "group_names" : "customer-rules", "delete_allowed" : true, "min_match" : 1 } ], "total" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。