文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产透视/ 查询资产目录分类结果top5 - ListClassificationTop
更新时间:2026-10-09 GMT+08:00
分享

查询资产目录分类结果top5 - ListClassificationTop

功能介绍

功能介绍:查询资产目录分类结果top5

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/metadata/catalog/classification-top

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

label_id

否

String

参数解释:

标签ID

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

type_id

否

String

参数解释:

类型ID

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

不涉及

classification_name

否

String

参数解释:

分类名称

约束限制:

不涉及

取值范围:

1到256个字符

默认取值:

all

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

1000

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

detection_classifications

ClassificationRule object

参数解释:

检测分类列表

取值范围:

不涉及

classification_name

String

参数解释:

分类名称

取值范围:

不涉及

column_details

Array of strings

参数解释:

列详情

取值范围:

不涉及

hit_number

Integer

参数解释:

命中数量

取值范围:

不涉及

表5 ClassificationRule

参数

参数类型

描述

classification_name

String

参数解释:

分类规则名称

取值范围:

不涉及

hit_number

Integer

参数解释:

命中数量

取值范围:

不涉及

column_details

ColumnInfoAndMatchInfo object

参数解释:

列详情

取值范围:

不涉及

表6 ColumnInfoAndMatchInfo

参数

参数类型

描述

column_fqn

String

参数解释:

列全限定名

取值范围:

不涉及

asset_id

String

参数解释:

资产ID

取值范围:

不涉及

asset_name

String

参数解释:

资产名称

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

match_infos

Array of ClassificationMatchInfo objects

参数解释:

匹配信息列表

取值范围:

不涉及

表7 ClassificationMatchInfo

参数

参数类型

描述

template_id

String

参数解释:

模板ID

取值范围:

不涉及

template_name

String

参数解释:

模板名称

取值范围:

不涉及

rule_id

String

参数解释:

规则ID

取值范围:

不涉及

rule_name

String

参数解释:

规则名称

取值范围:

不涉及

security_level_name

String

参数解释:

安全等级名称

取值范围:

不涉及

security_level_id

String

参数解释:

分类匹配信息ID

取值范围:

不涉及

security_level_color

Integer

参数解释:

安全等级颜色

取值范围:

不涉及

classification_name

String

参数解释:

分类匹配信息名称

取值范围:

不涉及

classification_id

String

参数解释:

分类匹配信息ID

取值范围:

不涉及

matched_detail

String

参数解释:

匹配详情

取值范围:

不涉及

match_content_cnt

Integer

参数解释:

匹配内容数量

取值范围:

不涉及

match_rate

Double

参数解释:

匹配率

取值范围:

不涉及

template_type

String

参数解释:

分类匹配信息类型

取值范围:

不涉及

manual_modify

Boolean

参数解释:

是否人工修改

取值范围:

true-是,false-否

matched_examples

Array of MatchedExamples objects

参数解释:

匹配示例列表

取值范围:

不涉及

表8 MatchedExamples

参数

参数类型

描述

line_number

Long

参数解释:

行号

取值范围:

不涉及

matched_content

String

参数解释:

匹配内容

取值范围:

不涉及

context

String

参数解释:

上下文信息

取值范围:

不涉及

nlp_revised

Boolean

参数解释:

nlp是否对matchedContent有过优化.

取值范围:

true-是,false-否

请求示例

查询资产目录分类结果top5

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/metadata/catalog/classification-top

响应示例

状态码:200

{
  "detection_classifications" : {
    "classification_name" : "classification-resource-01",
    "hit_number" : 1,
    "column_details" : {
      "column_fqn" : "asset-value-01",
      "asset_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
      "asset_name" : "asset-db-01",
      "db_type" : "MySQL",
      "match_infos" : [ {
        "template_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
        "template_name" : "asset-template-01",
        "rule_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
        "rule_name" : "classification-rule-01",
        "security_level_name" : "security_level-resource-01",
        "security_level_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
        "security_level_color" : 1,
        "classification_name" : "classification-resource-01",
        "classification_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "matched_detail" : "asset-value-01",
        "match_content_cnt" : 1,
        "match_rate" : 95.5,
        "template_type" : "DATABASE",
        "manual_modify" : true,
        "matched_examples" : [ {
          "line_number" : 1,
          "matched_content" : "asset-value-01",
          "context" : "asset-value-01",
          "nlp_revised" : true
        } ]
      } ]
    }
  }
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档