此手册用于记录大数据开发与管理平台中，安全中心务产品所有对外开放的OpenAPI，阅读此手册，你将了解安全中心开放的OpenAPI能力与调用方法。

一、公共参数

1.1 响应格式

名称 类型 描述
code Number 响应码
reqId String 请求ID
cost Number 耗时，单位：ms
msg String 响应消息
result Object 响应结果

1.2 异常响应码

响应码 说明
1000 查询异常
2000 变更异常

1.3 枚举列表

1.3.1 HiveActionEnum

Hive的权限枚举

枚举值 类型 名称
create String 建表
select String 查
update String 写
alter String 改表
drop String 删表
1.3.2 HdfsActionEnum

Hdfs的权限枚举

枚举值 类型 名称
read String 读
write String 写
execute String 执行
1.3.3 DataAuthActionEnum

所有资源类型的权限枚举。

枚举值 类型 名称
create String 建表
select String 查
update String 写
alter String 改表
drop String 删表
read String 读
write String 写
execute String 执行
1.3.4 ObjectTypeEnum
枚举值 类型 名称
user String 用户
role String 角色
1.3.5 ResourceTypeEnum

资源类型

枚举值 类型 名称
hive_db String hive库
hive_table String hive表
hdfs_path String 路径
1.3.6 ServiceTypeEnum
枚举值 类型 名称
HIVE String
HDFS String 无
1.3.7 EffectTypeEnum

生效类型

枚举值 类型 名称
ALLOW String 允许策略
DENY String 拒绝策略
1.3.8 RoleBelongTypeEnum

生效类型

枚举值 类型 名称
PRODUCT String 项目
TENANT String 项目组

1.4 请求实体列表

1.4.1 DataResourceItem

数据资源item

字段 类型 描述
serviceType ServiceTypeEnum hive or hdfs
db String hive库名
tbl String hive表名
col String hive列名
associate Boolean hive是否级联 默认为false
path String hdfs路径
recursive Boolean hdfs是否递归 默认为true

上述字段根据serviceType判断是否必填

1.4.2 DataAuthActionItem
字段 类型 描述
action [DataAuthActionEnum] 动作
expireTime Number 权限到期时间戳 13位
1.4.3 DataAuthItem
字段 类型 描述
dataResource DataResourceItem 资源
dataAuthActionItems List<DataAuthActionItem> actionList
1.4.4 DataAuthOperateRequest
名称 类型 描述 必须
clusterId String 集群id 是
product String 项目名称 是
authItems List<DataAuthItem> 资源类型 长度有限制 max_size:10 是
users List<String> 用户邮箱List，查询用户时传 max_size:20 否
roles List<String> 角色唯一标识List max_size:20 否
operator String 操作人 是
1.4.5 CreateTenantRoleRequest
名称 类型 描述 必须
description String 项目组角色中文名称 是
info String 项目组角色描述 是
tenantId Long 项目组ID 是

1.5 响应实体列表

1.5.1 PageResult

分页查询结果

字段 类型 描述
pageSize Number 每页显示条数
pageNum Number 页数
totalCount Number 总条数
totalPage Number 总页数
list Array<Object> 当前页结果
1.5.2 Role

角色

字段 类型 描述
name String 角色唯一标识
product String 项目
tenant Long 项目组
roleBelongType RoleBelongTypeEnum 角色所属类型
description String 角色中文名 无
1.5.3 DataAuthAction

数据权限动作

字段 类型 描述
action [DataAuthActionEnum] 动作
expireTime Number 权限到期时间戳 13位
effect [EffectTypeEnum] 策略类型
1.5.4 DataAuthResponse

数据权限

字段 类型 描述 是否必填
object String 授权对象 是
objectType [ObjectTypeEnum] 授权对象类型 是
resourceValue String 资源值 是
resourceType [ResourceTypeEnum] 资源类型 是
serviceType [ServiceTypeEnum] service类型 是
recursive Boolean 是否递归 否
clusterId String 集群id 是
actions List<DataAuthAction> 动作类型列表 是
1.5.5 DataAuthOperateResponse
字段 类型 描述
status Boolean 结果状况
errorObjects List<DataAuthOperateErrorItem> 异常Item
1.5.6 DataAuthOperateErrorItem
字段 类型 描述
object String 用户邮箱、角色key
objectType String user，role
dataAuth DataAuthItem 失败资源内容
errorMsg String 失败消息
1.5.7 TenantRole

项目组角色

字段 类型 描述
name String 角色唯一标识key
tenantId Long 项目组id
description String 项目组角色中文名
info String 项目组角色描述 无
1.5.8 User

成员实体类

字段 类型 描述
name String 成员邮箱
fullName String 成员中文名 无
1.5.9 IdentifyTask

识别任务

字段 类型 描述
id Number 任务id
name String 识别任务名称
identifyRangeInfo [IdentifyRangeInfo] 识别任务范围
1.5.10 IdentifyRangeInfo
字段 类型 描述
db String 数据库名
rangeType String 识别返回类型
ALL:全库
ENUMERATE：具体表
CUSTOMIZE：自定义正则匹配
regular String 正则表达式
identifyTableInfoList List<IdentifyTableInfo> 识别表List
1.5.11 IdentifyTableInfo
字段 类型 描述
table String 表名
partitionValueMap Map<String,List<String>> 分区，分区值Map
1.5.12 ExecutionItem
字段 类型 描述
taskRecordId Number 任务运行记录id
execId Number 实例id
status String 运行状态
1.5.13 IdentifyResult
字段 类型 描述
db String 库
tbl String 表
col String 列
clusterId String 集群名称
colType String 列类型
sensitiveType String 敏感类型
securityLevel String 安全等级
maskRuleType String 脱敏规则
effectiveMaskRuleType String 已生效脱敏规则
effectiveSecurityLevel String 已生效安全等级
effectiveSensitiveType String 已生效敏感类型
sampleData String 识别样例数据

二、OpenAPI列表

2.1 OpenAPI总览

模块名称支持版本状态请求方法请求路径
角色查询查询项目下所有角色v3.6.2已发布GET/role/v1/get
查询用户所拥有的角色v3.8.0测试中GET/role/v1/by-user/get
权限查询

查询用户/角色在库上的权限v3.6.2已发布GET/permission/v1/hive/db/search
查询用户/角色在表上的权限v3.6.2已发布GET/permission/v1/hive/table/search
查询用户/角色在列上的权限v3.6.2已发布GET/permission/v1/hive/column/search
查询用户/角色在路径上的权限v3.6.2已发布GET/permission/v1/hdfs/path/search
查询用户拥有的库权限v3.6.2已发布GET/permission/v1/user-permission/hive/db/search
查询用户拥有的表权限v3.6.2已发布GET/permission/v1/user-permission/hive/table/search
项目修改项目中删除用户v3.8.0测试中POST/product/v1/user/delete
数据授权数据权限授权v3.9.0POST/permission/v1/grant
数据权限回收v3.9.0POST/permission/v1/revoke
用户信息用户所加入的项目v3.9.2GET/user/v1/product/get
项目组管理项目组级别角色新增v.3.9.6.2待评审POST/tenant/v1/role/create
项目组级别角色删除v.3.9.6.2待评审POST/tenant/v1/role/delete
项目组级别角色查询v.3.9.6.2待评审GET/tenant/v1/role/search
项目组级别角色修改名称描述v.3.9.6.2待评审POST/tenant/v1/role/update
项目组级别角色加成员v.3.9.6.2待评审POST/tenant/v1/role/add-member
项目组级别角色删成员v.3.9.6.2待评审POST/tenant/v1/role/remove-member
项目组级别角色查成员v.3.9.6.2待评审GET/tenant/v1/role/member/search
成员加入项目组v.3.9.6.2待评审POST/tenant/v1/membership/join
成员退出项目组v.3.9.6.2待评审POST/tenant/v1/membership/leave
数据识别根据项目返回识别任务列表v.3.9.8待评审GET/identify-task/v1/get
根据项目+识别任务id返回实例列表v.3.9.8待评审GET/identify-task/v1/execution-job/get
根据实例ID返回识别结果v.3.9.8待评审GET/identify-task/v1/identify-result/get

2.2 角色查询

2.2.1 查询项目下所有角色

GET /role/v1/get （开新接口）

产品版本：v3.6.2

描述：查询项目下所有角色

URL参数/请求体

名称 类型 描述 必须 默认值
product String 项目名称 是
pageSize Number 每条页数 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<Role> 角色列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "name": "intern\_2",

            "product": "intern",

            "description": "管理员"

        }

    \]

}

}

2.2.2 查询单个用户所拥有角色

GET /role/v1/by-user/get

产品版本：v3.9.2

描述：查询用户所属的角色

URL参数/请求体

名称 类型 描述 必须 默认值
user String 用户邮箱 是
belongType RoleBelongTypeEnum 角色所属（项目、项目组） 是
belongName String 项目名称 or 项目组id 是
pageSize Number 每条页数 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<Role> 角色列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "name": "intern\_2",

            "product": "intern",

            "description": "管理员",

            "belongType": "PRODUCT",

            "belongName": "data\_transform"

        }

    \]

}

}

2.3 角色修改

2.4 权限查询

2.4.1 查询用户/角色在库上的权限

GET /permission/v1/hive/db/search

产品版本：v3.6.2

描述：查询用户或角色在库上的权限，查询用户权限时，包含用户所在角色拥有的权限

URL参数/请求体

名称 类型 描述 必须 默认值
clusterId String 集群id 是
product String 项目名称，db所在的项目 是
db String 库名 是
user String 用户邮箱，查询用户时传（不能与role同时非空） 否
role String 角色唯一标识（不能与user同时非空） 否
searchType ObjectTypeEnum 查询类型 是 无

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<HiveActionEnum> 权限列表

响应示例：

{

"code": 0,

"reqId": "e241e7175ce3420681cc14df360c955f",

"cost": 12,

"msg": "success",

"result": \[

    "drop",

    "select",

    "update",

    "create",

    "alter"

\]

}

2.4.2 查询用户/角色在表上的权限

GET /permission/v1/hive/table/search

产品版本：v3.6.2

描述：查询用户或角色在表上的权限，查询用户权限时，包含用户所在角色拥有的权限

URL参数/请求体

名称 类型 描述 必须 默认值
clusterId String 集群id 是
product String 项目名称，table所在的项目 是
db String 库名 是
table String 表名 是
user String 用户邮箱，查询用户时传 否
role String 角色唯一标识 否
searchType ObjectTypeEnum 查询类型 是 无

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<HiveActionEnum> 权限列表

响应示例：

{

"code": 0,

"reqId": "e241e7175ce3420681cc14df360c955f",

"cost": 12,

"msg": "success",

"result": \[

    "drop",

    "select",

    "update",

    "alter"

\]

}

2.4.3 查询用户/角色在列上的权限

GET /permission/v1/hive/column/search

产品版本：v3.6.2

描述：查询用户或角色在hive库上的权限，查询用户权限时，包含用户所在角色拥有的权限

URL参数/请求体

名称 类型 描述 必须 默认值
clusterId String 集群id 是
product String 项目名称，column所在的项目 是
db String 库名 是
table String 表名 是
column String 列名 是
user String 用户邮箱，查询用户时传 否
role String 角色唯一标识 否
searchType ObjectTypeEnum 查询类型 是 无

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<HiveActionEnum> 权限列表

响应示例：

{

"code": 0,

"reqId": "e241e7175ce3420681cc14df360c955f",

"cost": 12,

"msg": "success",

"result": \[

    "drop",

    "select",

    "update",

    "alter"

\]

}

2.4.4 查询用户/角色在路径上的权限

GET /permission/v1/hdfs/path/search

产品版本：v3.6.2

描述：查询用户或角色在hdfs路径上的权限(精确匹配)，查询用户权限时，包含用户所在角色拥有的权限

URL参数/请求体

名称 类型 描述 必须 默认值
clusterId String 集群id 是
path String 路径 是
recursive Boolean 是否递归 是
user String 用户邮箱，查询用户时传 否
role String 角色唯一标识 否
searchType ObjectTypeEnum 查询类型 是 无

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<HdfsActionEnum> 权限列表

响应示例：

{

"code": 0,

"reqId": "e241e7175ce3420681cc14df360c955f",

"cost": 12,

"msg": "success",

"result": \[

    "drop",

    "select",

    "update",

    "alter"

\]

}

2.4.5 查询用户拥有的库权限

GET /permission/v1/user-permission/hive/db/search

产品版本：v3.6.2

描述：查询用户在集群中拥有的所有Hive库权限，包括用户所在角色拥有的权限

URL参数/请求体

名称 类型 描述 必须 默认值
clusterId String 集群id 是
user String 用户邮箱 是
keyword String 库名模糊搜索关键词 否
pageSize Number 每页条数 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<DataAuthResponse> 权限列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "object": "bdms\_lingzikang",

            "objectType": "user",

            "resourceValue": "ling\_test\_1015.\*.\*",

            "resourceType": "db",

            "resourceHash": -8841585264536912176,

            "serviceType": "hive",

            "clusterId": "dev4",

            "actionList": \[

                {

                    "action": "select",

                    "expireTime": 4102415999000,

                    "effect": "ALLOW"

                }

            \]

        }

    \]

}

}

2.4.6 查询用户拥有的表权限

GET /permission/v1/user-permission/hive/table/search

产品版本：v3.6.2

描述：查询用户在某一个库下所拥有的Hive表权限，包括用户所在角色拥有的权限

URL参数/请求体

名称 类型 描述 必须 默认值
clusterId String 集群id 是
db String 库名 是(否)
user String 用户邮箱 是
keyword String 库名模糊搜索关键词 否
pageSize Number 每页条数 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<ataAuthResponse> 权限列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "object": "bdms\_lingzikang",

            "objectType": "user",

            "resourceValue": "ling\_test\_1015.test\_tbl.\*",

            "resourceType": "table",

            "resourceHash": -88415823464536912176,

            "serviceType": "hive",

            "clusterId": "dev4",

            "actionList": \[

                {

                    "action": "select",

                    "expireTime": 4102415999000,

                    "effect": "ALLOW"

                }

            \]

        }

    \]

}

}

2.5 用户信息查询

2.5.1 查询用户加入的项目

GET /user/v1/product/get

产品版本：v3.9.2

描述：查询用户所加入的项目

URL参数/请求体

名称 类型 描述 必须 默认值
user String 用户邮箱 是 无

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<String> 项目List

响应示例：

{

"code": 0,

"msg": "success",

"result": \[

    "intern",

    "autoapi\_test",

    "data\_transform",

    "access",

    "easyaccess"

\],

"reqId": "1a49b51a0f574c4d8e3ffc975e22cc95.113.16674610709110249",

"cost": 18

}

2.6 项目修改

2.6.1 项目中移除用户

~POST /product/v1/user/delete~

产品版本：v3.8.0

描述：将用户从项目中移除，移除用户与组的关系，支持用户List，猛犸接口调用

URL参数/请求体

名称 类型 描述 必须 默认值
product String 项目 是
users List<String> 用户邮箱List 注：列表数量上线50 是 无

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": true

}

2.7 数据权限操作

2.7.1 授权

POST /permission/v1/data-auth/grant

产品版本：v3.9.0

描述：数据权限，授权

URL参数/请求体

名称 类型 描述 必须
dataAuthOperateRequest DataAuthOperateRequest 数据操作对象 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result DataAuthOperateResponse 响应体

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result":{

    "status": false,

    "errorObjects":

    \[

        {

            "object": "xxxx@163.com",

            "objectType": "user",

            "dataAuth":

            {

                "dataResourceItem":

                {

                    "serviceType": "hdfs",

                    "path": "a",

                    "isAssociation": true

                },

                "dataAuthActionItems":

                \[

                    {

                        "action": "select",

                        "expireTime": 1234567890987

                    }

                \]

            },

            "errorMsg": "error msg.."

        }

    \]

}

}

2.7.2 权限回收

POST /permission/v1/data-auth/revoke

产品版本：v3.9.0

描述：数据权限回收

URL参数/请求体

名称 类型 描述 必须
dataAuthOperateRequest DataAuthOperateRequest 数据操作对象 是

响应

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result DataAuthOperateResponse 响应体

响应实例

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "status": false,

    "errorObjects":

    \[

        {

            "object": "xxxx@163.com",

            "objectType": "user",

            "dataAuth":

            {

                "dataResourceItem":

                {

                    "serviceType": "hive",

                    "db": "a",

                    "tbl": "\*",

                    "col": "\*",

                    "isAssociation": true

                },

                "dataAuthActionItems":

                \[

                    {

                        "action": "select"

                    }

                \]

            },

            "errorMsg": "error msg.."

        }

    \]

}

}

2.8 项目组管理

2.8.1 项目组级别角色新增

POST /tenant/v1/role/create

产品版本：v3.9.6.2

描述：项目组级别角色新增

URL参数/请求体

名称 类型 描述 必须
createTenantRoleRequest CreateTenantRoleRequest 新增项目组级角色 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": true

}

2.8.2 项目组级别角色删除

POST /tenant/v1/role/delete

产品版本：v3.9.6.2

描述：项目组级别角色删除

URL参数/请求体

名称 类型 描述 必须
name String 项目组级角色key 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": true

}

2.8.3 项目组级别角色查询

GET /tenant/v1/role/search

产品版本：v3.9.6.2

描述：项目组级别角色删除

URL参数/请求体

名称 类型 描述 必须
tenantId Long 项目组id 是
keyword String 项目组角色中文名模糊搜索 否

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<TenantRole> 角色列表

响应示例：


{

  "code": 0,

  "reqId": "70764cf3020c4aaaa455eaa0f04ec988",

  "cost": 23,

  "msg": "success",

  "result": \[

    {

      "key": "tenant\_1\_1",

      "tenantId": 1,

      "name": "负责人",

      "description": "xxx项目组负责人"

    }

  \]

}
2.8.4 项目组级别角色修改名称描述

POST /tenant/v1/role/update

产品版本：v3.9.6.2

描述：项目组级别角色修改名称描述

URL参数/请求体

名称 类型 描述 必须
name String 角色唯一标识key 是
description String 项目组角色中文名 是
info String 项目组角色描述 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": true

}

2.8.5 项目组级别角色加成员

POST /tenant/v1/role/add-member

产品版本：v3.9.6.2

描述：项目组级别角色加成员，已在角色中则直接返回

URL参数/请求体

名称 类型 描述 必须
name String 角色唯一标识key 是
user String 用户邮箱 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": true

}

2.8.6 项目组级别角色删成员

POST /tenant/v1/role/remove-member

产品版本：v3.9.6.2

描述：项目组级别角色删成员，不在角色中则直接返回

URL参数/请求体

名称 类型 描述 必须
name String 角色唯一标识key 是
user String 用户邮箱 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": true

}

2.8.7 项目组级别角色查成员

GET /tenant/v1/role/member/search

产品版本：v3.9.6.2

描述：项目组级别角色查询成员

URL参数/请求体

名称 类型 描述 必须
name String 角色唯一标识key 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result List<user> 成员列表

响应示例：


{

  "code": 0,

  "reqId": "70764cf3020c4aaaa455eaa0f04ec988",

  "cost": 23,

  "msg": "success",

  "result": \[

    {

      "name": "lingzikang@corp.netease.com", user

      "description": "凌子康", fullName

    }

  \]

}
2.8.8 成员加入项目组

POST /tenant/v1/membership/join

产品版本：v3.9.6.2

描述：成员加入项目组，若成员已在项目组则直接返回

URL参数/请求体

名称 类型 描述 必须
tenantId Long 项目组Id 是
user String 成员邮箱 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：


{

  "code": 0,

  "reqId": "70764cf3020c4aaaa455eaa0f04ec988",

  "cost": 23,

  "msg": "success",

  "result": true

}
2.8.9 成员退出项目组

POST /tenant/v1/membership/leave

产品版本：v3.9.6.2

描述：成员退出项目组，若成员已不在项目组则直接返回

URL参数/请求体

名称 类型 描述 必须
tenantId Long 项目组Id 是
user String 成员邮箱 是

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result boolean 是否成功

响应示例：


{

  "code": 0,

  "reqId": "70764cf3020c4aaaa455eaa0f04ec988",

  "cost": 23,

  "msg": "success",

  "result": true

}

2.9 数据识别

2.9.1 根据项目返回识别任务列表

GET /identify-task/v1/get

产品版本：v3.9.8

描述：查询识别任务列表

URL参数/请求体

名称 类型 描述 必须
product String 项目唯一标识key 是
pageSize Number 每页条数 max:1000 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result PageResult<IdentifyTask> 成员列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "id": 1,

            "name": "识别任务",

            "identifyRangerInfo": {

                "db":"db",

                "rangeType":"ALL"

            }

        },

        {

            "id": 2,

            "name": "指定表识别任务",

            "identifyRangerInfo": {

                "db":"db",

                "rangeType":"ENUMERATE",

                "identifyTableInfoList":\[

                    {

                        "table":"tbl",

                        "partitionValueMap":{

                            "partition1":\["a","b","c"\],

                            "partition2":\["1","2","3"\],

                        }

                    }

                \]

            }

        },

        {

            "id": 3,

            "name": "正则匹配识别任务",

            "identifyRangerInfo": {

                "db":"db",

                "rangeType":"CUSTOMIZE",

                "regular":".\*"

            }

        }

    \]

}

}

2.9.2 根据项目+识别任务id返回实例列表

GET /identify-task/v1/execution-job/get

产品版本：v3.9.8

描述：项目组级别角色查询成员

URL参数/请求体

注意：一个execId + jobId 才能确认一个唯一执行任务

名称 类型 描述 必须 默认值
product String 项目唯一标识key 否
taskId Number 识别任务id 是
status String 状态加枚举 否
startTime Number 开始时间 13位时间戳 否
endTime Number 结束时间 13位时间戳 否
pageSize Number 每页条数 max:1000 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result PageResult<ExecutionItem> 成员列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "execId": 1,

            "taskRecordId": 6;

            "status": "running"

        }

    \]

}

}

2.9.3 根据实例列表返回识别结果

GET /identify-task/v1/identify-result/get

产品版本：v3.9.8

描述：项目组级别角色查询成员

URL参数/请求体

名称 类型 描述 必须 默认值
execId Number 实例id 是
taskRecordId Number 任务运行记录id 是
pageSize Number 每页条数 max:1000 否 25
pageNum Number 当前页码 否 1

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result PageResult<IdentifyResult> 成员列表

响应示例：

{

"code": 0,

"reqId": "70764cf3020c4aaaa455eaa0f04ec988",

"cost": 23,

"msg": "success",

"result": {

    "pageSize": 1,

    "pageNum": 1,

    "total": 67,

    "totalPage": 68,

    "list": \[

        {

            "db":"da",

            "tbl":"t",

            "col":"c",

            "clusterId":"dev4",

            "colType":"String",

            "sensitiveType":"邮编",  //是否要多个

            "securityLevel":"S4",

            "maskRuleType":"哈希",

            "effectiveSecurityLevel":"S3",

            "effectiveSensitiveType":"地址",

            "effectiveMaskRuleType":"遮盖",

            "smapleData":"a"

        }

    \]

}

}