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

导入预置分类

功能介绍

导入预置分类。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/security/data-category/import-builtin-category

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

workspace

是

String

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

X-Auth-Token

是

String

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

X-Language

是

String

请求语言

  • zh-cn 中文

  • en-us 英文
表3 请求Body参数

参数

是否必选

参数类型

描述

rule_secrecy_level_list

否

Array of ImportRuleSecrecyLevelDto objects

规则的密级列表。
表4 ImportRuleSecrecyLevelDto

参数

是否必选

参数类型

描述

builtin_rule_id

否

String

内置规则模板id。

secrecy_level

否

String

密级id，获取方法请参见获取数据密级。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

Array of ImportDefaultCategoryResultDto objects

导入结果。
表6 ImportDefaultCategoryResultDto

参数

参数类型

描述

import_status

String

导入状态

  • success 导入成功

  • failed 导入失败

import_error_message

String

导入错误原因。

children

Array of ImportDefaultCategoryResultDto objects

子分类导入结果。

rule_result

Array of ImportDefaultRuleResultDto objects

此分类绑定的规则导入的结果。

uuid

String

数据分类id。

name

String

数据分类名称。

description

String

数据分类描述。
表7 ImportDefaultRuleResultDto

参数

参数类型

描述

import_status

String

导入状态

  • success 导入成功

  • failed 导入失败

import_error_message

String

导入错误原因。

uuid

String

内置规则模板id。

import_data_classification_rule

Object

导入成功的识别规则。

rule_name

String

数据识别规则名称。

rule_type

String

数据识别规则类型

  • REGEX 正则表达式

  • KEYWORD 关键字

rule_desc

String

规则描述。

rule_name_en

String

英文名称。

rule_desc_en

String

英文描述。

country

String

规则所属地区。
表8 ImportDataClassificationRuleDto

参数

参数类型

描述

uuid

String

数据识别规则id。

classification_type

String

识别规则类型

  • BUILTIN 内置

  • CUSTOM 自定义

secrecy_level

String

数据密级id。

name

String

数据识别规则名称。

enable

Boolean

是否启用。

method

String

识别规则类型

  • NONE 无

  • REGULAR 正则表达式

  • DEFAULT 默认

description

String

描述。

category_id

String

数据分类id。

builtin_rule_id

String

预置规则id。

updated_by

String

更新人。

update_at

Long

更新时间。

created_by

String

创建人。

create_at

Long

创建时间。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

/v1/0833a5737480d53b2f25c010dc1a7b88/security/data-category/import-builtin-category

{
  "rule_secrecy_level_list" : [ {
    "builtin_rule_id" : "a5adcd6881f011e9a870765a9db3b202",
    "secrecy_level" : "8a9480087df0657e017df070a7620000"
  } ]
}

响应示例

状态码： 200

OK

{
  "result" : [ {
    "name" : "个人信息",
    "children" : [ ],
    "description" : null,
    "import_error_message" : null,
    "import_status" : "success",
    "uuid" : "17fc7b0053c246518ade09feca480000",
    "rule_result" : [ {
      "uuid" : "a5adcb7a81f011e9a870765a9db3b202",
      "country" : "China",
      "import_data_classification_rule" : {
        "builtin_rule_id" : "a5adcb7a81f011e9a870765a9db3b202",
        "category_id" : "d4e8d3a67f984bc49907046e8fe37db0",
        "classification_type" : "BUILTIN",
        "created_at" : 1716773669838,
        "created_by" : "user1",
        "description" : "中国身份证号",
        "enable" : true,
        "method" : "DEFAULT",
        "name" : "中国身份证号",
        "secrecy_level" : "8a9481b68f7a96e7018fb7ae6814021b",
        "updated_at" : 1716773669838,
        "updated_by" : "user1",
        "uuid" : "8a9481b68f7a96e7018fb7af4bce0221"
      },
      "import_error_message" : null,
      "import_status" : "success",
      "rule_desc" : "中国身份证号",
      "rule_desc_en" : "ID card number in (China)",
      "rule_name" : "中国身份证号",
      "rule_name_en" : "ID_Card_Number_(China)",
      "rule_type" : "REGEX"
    } ]
  } ]
}

状态码

状态码

描述

200

OK

400

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

相关文档