文档

DescribeCategoryTemplateRuleList - 查询分类分级模板的规则列表

更新时间:

分页获取分类分级模板的规则列表。

接口说明

本接口一般用于获取当前使用模板的规则列表,便于了解当前使用模板的规则详情。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sddp:DescribeCategoryTemplateRuleListRead
  • acs:yundun-sddp::{#accountId}:*

请求参数

名称类型必填描述示例值
Langstring

请求和接收消息的语言类型,默认值为zh_cn。取值:

  • zh_cn:中文(简体)。
  • en_us:英文(美国)。
zh_cn
PageSizeinteger

设置每页显示模板规则的条数,默认值为 10

10
CurrentPageinteger

设置当前页的页码,默认值为 1

1
Statusinteger

模板规则的开启状态,默认值为 null。取值:

  • 0:表示未开启状态。
  • 1:表示开启状态。
  • null:表示全部状态,包括:开启和未开启状态。
1
RiskLevelIdlong

模板规则的风险等级。取值范围为 1~11,默认值为 null。取值:

  • 1:表示无风险。
  • 2:表示 S1 级风险等级。
  • 3:表示 S2 级风险等级。
  • 4:表示 S3 级风险等级。
  • 5:表示 S4 级风险等级。
  • 6:表示 S5 级风险等级。
  • 7:表示 S6 级风险等级。
  • 8:表示 S7 级风险等级。
  • 9:表示 S8 级风险等级。
  • 10:表示 S9 级风险等级。
  • 11:表示 S10 级风险等级。
  • null:表示全部风险等级,包括:无风险、S1、S2、S3、S4、S5、S6、S7、S8、S9 和 S10 级风险等级。
2
FeatureTypeinteger

该参数已废弃。

1

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前页的页码。

1
RequestIdstring

返回结果的请求 ID。

136082B3-B21F-5E9D-B68E-991FFD205D24
PageSizeinteger

每页显示模板规则的条数。

10
TotalCountinteger

当前模板的规则总数。

10
Itemsobject []

模板规则列表。

Statusinteger

模板规则的开启状态。取值:

  • 0:表示未开启状态。
  • 1:表示开启状态。
  • null:表示全部状态,包括:开启和未开启状态。
1
IdentificationScopestring

模板规则用于扫描数据的范围。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个扫描数据的范围,包含以下字段:

  • Asset:String 类型,表示资产类型,包括:RDS、DRDS、PolarDB、OTS、ADB、OceanBase。

  • Content:String 类型,表示扫描资产的范围。JSON 数组中的每个元素是一个扫描数据的范围,包含以下字段:

    • Range:String 类型,表示匹配范围,包括:Instance、database、table、column、project(只适用于 MaxCompute 资产类型)、bucket(只适用于 OSS 资产类型)、object(只适用于 OSS 资产类型)。

    • Operator:String 类型,表示匹配条件,包括:equals(表示等于)、 regex(表示正则匹配)、prefix(表示前缀匹配)、suffix(表示后缀匹配)。

    • Value:String 类型,表示匹配内容。

[{"Asset":"RDS","Content":[{"Range":"database","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"project","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]}]
RiskLevelIdlong

模板规则的风险等级。取值范围为 1~11。取值:

  • 1:表示无风险。
  • 2:表示 S1 级风险等级。
  • 3:表示 S2 级风险等级。
  • 4:表示 S3 级风险等级。
  • 5:表示 S4 级风险等级。
  • 6:表示 S5 级风险等级。
  • 7:表示 S6 级风险等级。
  • 8:表示 S7 级风险等级。
  • 9:表示 S8 级风险等级。
  • 10:表示 S9 级风险等级。
  • 11:表示 S10 级风险等级。
  • null:表示全部风险等级,包括:无风险、S1、S2、S3、S4、S5、S6、S7、S8、S9 和 S10 级风险等级。
2
Descriptionstring

规则描述。

用于识别身份证号的模板规则
IdentificationRuleIdsstring

关联的原子模型 ID 列表,通过半角逗号(,)分隔。

1001,1002
Namestring

模板规则名字。

身份证号
Idlong

该模板规则的唯一标识 ID。

100

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "136082B3-B21F-5E9D-B68E-991FFD205D24",
  "PageSize": 10,
  "TotalCount": 10,
  "Items": [
    {
      "Status": 1,
      "IdentificationScope": "[{\"Asset\":\"RDS\",\"Content\":[{\"Range\":\"database\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"RDS\",\"Content\":[{\"Range\":\"table\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"RDS\",\"Content\":[{\"Range\":\"column\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"ODPS\",\"Content\":[{\"Range\":\"project\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"ODPS\",\"Content\":[{\"Range\":\"table\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"ODPS\",\"Content\":[{\"Range\":\"column\",\"Operator\":\"regex\",\"Value\":\"register\"}]}]",
      "RiskLevelId": 2,
      "Description": "用于识别身份证号的模板规则",
      "IdentificationRuleIds": "1001,1002",
      "Name": "身份证号",
      "Id": 100
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-25OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:FeatureType
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈