全部产品
Search

搜索本产品

    数据安全中心：DescribeRules - 查询识别规则的列表

    文档中心

    数据安全中心：DescribeRules - 查询识别规则的列表

    更新时间：Oct 17, 2024

    调用本接口查询敏感数据识别规则的列表。

    调试

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

    授权信息

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

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

    请求参数

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

    请求和接收消息的语言类型。取值：

    • zh：中文。
    • en：英文。
    		zh
    PageSizeinteger否

    列表每页显示的数据最大条数。

    		12
    CurrentPageinteger否

    分页查询时的页码。

    		1
    CustomTypeinteger否

    敏感数据识别规则的类型。取值：

    • 0：表示系统内置。
    • 1：表示用户自定义。
    		1
    Categoryinteger否

    敏感数据识别规则内容的类型。取值：

    • 0：关键字。
    • 2：正则表达式。
    		2
    Namestring否

    敏感数据识别规则名称，支持模糊匹配。

    		***规则
    RiskLevelIdlong否

    敏感数据识别规则的敏感等级 ID。取值：

    • 1：N/A：未识别到敏感数据。
    • 2：S1：1 级敏感数据。
    • 3：S2：2 级敏感数据。
    • 4：S3：3 级敏感数据。
    • 5：S4：4 级敏感数据。
    		2
    RuleTypeinteger否

    敏感数据识别规则的类型。取值：

    • 1：数据识别规则。
    • 2：审计规则。
    • 3：异常检测规则。
    • 99：自定义规则。
    		1
    MatchTypeinteger否

    匹配类型。取值：

    • 1：规则匹配。
    • 2：词典匹配。
    		1
    ProductCodeinteger否

    数据资产所属的产品名称。取值：

    • MaxCompute。
    • OSS。
    • ADS：。
    • OTS。
    • RDS。
    • SELF_DB。
    		MaxCompute
    ProductIdlong否

    数据资产所属的产品名称对应的 ID。取值：

    • 1：MaxCompute。
    • 2：OSS。
    • 3：ADS。
    • 4：OTS。
    • 5：RDS。
    • 6：SELF_DB。
    		1
    WarnLevelinteger否

    危险等级。

    • 1：低危。
    • 2：中危。
    • 3：高危。
    		2
    ContentCategoryinteger否

    内容类型，取值：

    • 1：SQL 注入尝试利用。
    • 2：SQL 注入尝试绕过。
    • 3：存储过程滥用。
    • 4：缓冲区溢出。
    • 5：基于报错的 SQL 注入等。
    		1
    Statusinteger否

    状态。取值：

    • 1：正常。
    • 0：停用。
    		1
    KeywordCompatibleboolean否

    新旧版关键字是否兼容。

    • true：是。
    • false：否。
    说明 旧版请求参数 Category 的关键字类型取值为 0，新版请求参数 Category 的关键字类型取值为 5，根据业务选择是否需要兼容。
    		true
    GroupIdstring否

    规则父类分组。

    		4_1
    SupportForminteger否

    规则支持的数据资产类型，取值：

    • 0：支持全部资产。
    • 1：支持结构化资产。
    • 2：支持非结构化资产。
    说明 查询支持结构化资产或非结构化资产时，返回的数据中除包含查询的数据资产类型外，还包含全部资产。
    		1
    FeatureTypeinteger否

    该参数已废弃。

    		2

    返回参数

    名称类型描述示例值
    object
    CurrentPageinteger

    结果中显示的当前页的页码。

    		1
    RequestIdstring

    结果的请求 ID。

    		769FB3C1-F4C9-42DF-9B72-7077A8989C13
    PageSizeinteger

    结果中每页显示的数据条数。

    		12
    TotalCountinteger

    结果中数据的总条数。

    		23
    Itemsarray<object>

    敏感数据识别规则列表。

    Ruleobject

    敏感数据识别规则详情。

    DisplayNamestring

    敏感数据识别规则的创建人账号显示名。

    		****test
    Statusinteger

    敏感数据识别规则的检测状态。取值：

    • 0：关闭。
    • 1：开启。
    		1
    SupportForminteger

    规则支持的数据资产类型，取值：

    • 0：支持全部资产。
    • 1：支持结构化资产。
    • 2：支持非结构化资产。
    		2
    WarnLevelinteger

    危险等级。

    • 1：低危。
    • 2：中危。
    • 3：高危。
    		2
    UserIdlong

    敏感数据识别规则的创建人账号 ID。

    		0
    StatExpressstring

    统计表达式。

    		1
    GmtModifiedlong

    敏感数据识别规则的修改时间。格式：时间戳。单位：毫秒。

    		1545277010000
    RiskLevelIdlong

    敏感数据识别规则的敏感等级 ID。取值：

    • 1：N/A：未识别到敏感数据。
    • 2：S1：1 级敏感数据。
    • 3：S2：2 级敏感数据。
    • 4：S3：3 级敏感数据。
    • 5：S4：4 级敏感数据。
    		2
    Descriptionstring

    敏感数据识别规则的描述信息。

    		用于识别IP地址
    ProductIdlong

    数据资产所属的产品名称对应的 ID。取值：

    • 1：MaxCompute。
    • 2：OSS。
    • 3：ADS。
    • 4：OTS。
    • 5：RDS。
    • 6：SELF_DB。
    		2
    Namestring

    敏感数据识别规则的名称。

    		IP地址
    Contentstring

    敏感数据识别规则的内容。

    说明 内置识别规则，即 CustomType 为 0 的识别规则，不返回规则的内容。
    		(?:\\D|^)((?:(?:25[0-4]|2[0-4]\\d|1\\d{2}|[1-9]\\d{1})\\.)(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d?\\d)\\.){2}(?:25[0-5]|2[0-4]\\d|1[0-9]\\d|[1-9]\\d|[1-9]))(?:\\D|$)
    Targetstring

    数据资产所属的产品名称。取值：

    • MaxCompute。
    • OSS。
    • ADS：。
    • OTS。
    • RDS。
    • SELF_DB。
    		MaxCompute
    LoginNamestring

    敏感数据识别规则的创建人账号登录名。

    		det1111
    CategoryNamestring

    敏感数据识别规则内容所属类型名称。

    		正则表达式
    ContentCategorystring

    内容类型，取值：

    • 1：SQL 注入尝试利用。
    • 2：SQL 注入尝试绕过。
    • 3：存储过程滥用。
    • 4：缓冲区溢出。
    • 5：基于报错的 SQL 注入等。
    		1
    HitTotalCountinteger

    命中次数。

    		3
    GroupIdstring

    规则父类分组。

    		4_1
    CustomTypeinteger

    敏感数据识别规则类型。

    • 0：表示系统内置。
    • 1：表示用户自定义。
    		1
    RiskLevelNamestring

    敏感数据识别规则的风险等级名称。取值：

    • N/A：未识别到敏感数据。
    • S1：1 级敏感数据。
    • S2：2 级敏感数据。
    • S3：3 级敏感数据。
    • S4：4 级敏感数据。
    		S2
    GmtCreatelong

    敏感数据识别规则的创建时间。格式：时间戳。单位：毫秒。

    		1545277010000
    Categoryinteger

    敏感数据识别规则内容的类型。取值：

    • 0：关键字。
    • 2：正则表达式。
    		2
    MajorKeystring

    主维度 key。

    		key
    Idlong

    保存记录的敏感数据识别规则的唯一标识 ID。

    		20000
    ProductCodestring

    数据资产所属的产品名称。取值：

    • MaxCompute。
    • OSS。
    • ADS：。
    • OTS。
    • RDS。
    • SELF_DB。
    		MaxCompute
    MatchTypeinteger

    匹配类型。取值：

    • 1：规则匹配。
    • 2：词典匹配。
    		1

    示例

    正常返回示例

    JSON格式

    {
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 12,
  "TotalCount": 23,
  "Items": [
    {
      "DisplayName": "****test",
      "Status": 1,
      "SupportForm": 2,
      "WarnLevel": 2,
      "UserId": 0,
      "StatExpress": "1",
      "GmtModified": 1545277010000,
      "RiskLevelId": 2,
      "Description": "用于识别IP地址",
      "ProductId": 2,
      "Name": "IP地址",
      "Content": "(?:\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\d|1\\\\d{2}|[1-9]\\\\d{1})\\\\.)(?:(?:25[0-5]|2[0-4]\\\\d|[01]?\\\\d?\\\\d)\\\\.){2}(?:25[0-5]|2[0-4]\\\\d|1[0-9]\\\\d|[1-9]\\\\d|[1-9]))(?:\\\\D|$)",
      "Target": "MaxCompute",
      "LoginName": "det1111",
      "CategoryName": "正则表达式",
      "ContentCategory": "1",
      "HitTotalCount": 3,
      "GroupId": "4_1",
      "CustomType": 1,
      "RiskLevelName": "S2",
      "GmtCreate": 1545277010000,
      "Category": 2,
      "MajorKey": "key",
      "Id": 20000,
      "ProductCode": "MaxCompute",
      "MatchType": 1
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-03-25OpenAPI 入参发生变更查看变更详情
    2023-07-17OpenAPI 入参发生变更查看变更详情