DsgQuerySensResult - 获取敏感数据识别结果

更新时间:
复制为 MD 格式

该接口用于获取数据保护伞的敏感数据识别结果。

接口说明

该 API 功能对应数据保护伞控制台界面的查询功能,通过与租户 ID 关联,获取指定租户的敏感数据识别结果。

  • 支持根据数据源类型、项目空间等维度进行筛选。

  • 支持对某个字段进行升降序排序。

  • 支持分页查询。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:DsgQuerySensResult

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TenantId

string

租户 ID。您可登录 DataWorks 控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户 ID。

10241024

DbType

string

数据库类型,取值为:

  • ODPS.ODPS

  • HOLO.POSTGRES

  • EMR

ODPS.ODPS

ProjectName

string

DataWorks 工作空间的名称。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间名称。

project

SchemaName

string

Schema 名称。

schema

Table

string

表名称。

table

Col

string

字段名称。

col

NodeName

string

分类节点名称。

Personal information

Level

string

敏感字段等级。

3

SensStatus

string

字段敏感状态:

sensitive:敏感 noIdentify:未识别 noResult:无结果

1

SensitiveId

string

敏感字段 ID。

10241024

SensitiveName

string

敏感字段名称。

name

Order

string

排序方式:

  • DESC:降序。

  • ASC:升序。

DESC

OrderField

string

用于排序的字段:

  • gmt_create

  • gmt_modified

gmt_create

PageNo

integer

页码数,最小值为 1。

1

PageSize

integer

每页显示的条数,默认为 10 条,最大为 20 条。

10

返回参数

名称

类型

描述

示例值

object

返回数据。

Success

boolean

调用是否成功。

  • true:成功。

  • false:失败。

true

ErrorCode

string

错误码。

400

ErrorMessage

string

错误信息。

Missing parameter

HttpStatusCode

integer

HTTP 返回码。

400

Data

any

返回数据。

1234

RequestId

string

请求 ID,一次请求的唯一标识。

900000001

DynamicErrorCode

string

错误码。取值同 ErrorCode。

400

DynamicErrorMessage

string

错误信息。取值同 ErrorMessage。

Missing parameter

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 400,
  "Data": "1234",
  "RequestId": "900000001",
  "DynamicErrorCode": "400",
  "DynamicErrorMessage": "Missing parameter"
}

错误码

HTTP status code

错误码

错误信息

描述

400 BADPARAMETERS Parameters are missing or in the wrong format.

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

变更历史

更多信息,参考变更详情