文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据安全API/ 数据分类接口/ 查询数据分类列表
更新时间：2024-11-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询数据分类列表

功能介绍

查询数据分类列表。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/security/data-category

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示的条目数量。

offset

否

Integer

偏移量，表示从此偏移量开始查询，该值大于等于0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

X-Auth-Token

是

String

IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）使用Token认证时必选。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

数据分类总的数量

category_groups

Array of DataCategoryDTO objects

数据分类列表
表5 DataCategoryDTO

参数

参数类型

描述

category_id

String

分类id

category_name

String

分类名称

description

String

分类描述

category_level

Integer

分类层级

rule_list

Array of DataClassificationRuleQueryDTO objects

识别规则

root_id

String

分类树根节点

parent_id

String

父分类节点

category_path

String

分类树路径

create_by

String

创建者

create_time

Integer

创建时间

update_by

String

更新者

update_time

Integer

更新时间

project_id

String

项目id

instance_id

String

实例id

synchronize

Boolean

同步（默认都同步资产）

children

Array of DataCategoryDTO objects

子分类
表6 DataClassificationRuleQueryDTO

参数

参数类型

描述

uuid

String

规则ID。

rule_type

String

规则类型, CUSTOM, BUILTIN

secrecy_level

String

密级名称。

secrecy_level_num

Long

密级层级。

name

String

规则名称。

guid

String

guid。

enable

Boolean

规则是否开启。

method

String

规则方式, REGULAR, NONE, DEFAULT

content_expression

String

内容表达式。

column_expression

String

列表达式。

commit_expression

String

备注表达式。

project_id

String

项目ID。

description

String

规则描述。

created_by

String

策略创建人。

created_at

Long

策略创建时间。

updated_by

String

策略更新人。

updated_at

Long

策略更新时间。

builtin_rule_id

String

内置规则ID。

category_id

String

分类ID。

instance_id

String

实例ID。

match_type

String

匹配类型。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

/v1/0833a5737480d53b2f25c010dc1a7b88/security/data-category

响应示例

状态码： 200

OK

{
  "category_groups" : [ {
    "category_id" : "555fb01bfcf04fed8623f6cfe81ef9b8",
    "category_level" : 0,
    "category_name" : "测试分类名",
    "category_path" : "测试分类名",
    "children" : [ ],
    "create_by" : "chenxiaoyu",
    "create_time" : 1717055180592,
    "description" : "this is a example catagory",
    "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc",
    "parent_id" : "-1,",
    "project_id" : "0833a5737480d53b2f25c010dc1a7b88",
    "root_id" : "555fb01bfcf04fed8623f6cfe81ef9b8",
    "rule_list" : null,
    "synchronize" : false,
    "update_by" : null,
    "update_time" : null
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request
父主题： 数据分类接口

相关文档