该接口用于获取数据保护伞的敏感数据识别结果。
接口说明
该 API 功能对应数据保护伞控制台界面的查询功能,通过与租户 ID 关联,获取指定租户的敏感数据识别结果。
支持根据数据源类型、项目空间等维度进行筛选。
支持对某个字段进行升降序排序。
支持分页查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:DsgQuerySensResult |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TenantId |
string |
是 |
租户 ID。您可登录 DataWorks 控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户 ID。 |
10241024 |
| DbType |
string |
否 |
数据库类型,取值为:
|
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 |
| OrderField |
string |
否 |
用于排序的字段:
|
gmt_create |
| PageNo |
integer |
否 |
页码数,最小值为 1。 |
1 |
| PageSize |
integer |
否 |
每页显示的条数,默认为 10 条,最大为 20 条。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Success |
boolean |
调用是否成功。
|
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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。