调用DsgQuerySensResult接口,获取数据保护伞的敏感数据识别结果。
该API功能对应数据保护伞控制台界面的查询功能,通过与租户ID关联,获取指定租户的敏感数据识别结果。
- 支持根据数据源类型、项目空间等维度进行筛选。
- 支持对某个字段进行升降序排序。
- 支持分页查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DsgQuerySensResult | 系统规定参数。取值:DsgQuerySensResult。 |
TenantId | String | 是 | 10241024 | 租户ID。您可登录DataWorks控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户ID。 |
DbType | String | 否 | ODPS.ODPS | 数据库类型,取值为:
|
ProjectName | String | 否 | project | DataWorks工作空间的名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。 |
SchemaName | String | 否 | schema | Schema名称。 |
Table | String | 否 | table | 表名称。 |
Col | String | 否 | col | 字段名称。 |
NodeName | String | 否 | 个人信息 | 分类节点名称。 |
Level | String | 否 | 3 | 敏感字段等级。 |
SensStatus | String | 否 | 1 | 字段敏感状态:
|
SensitiveId | String | 否 | 10241024 | 敏感字段ID。 |
SensitiveName | String | 否 | 姓名 | 敏感字段名称。 |
Order | String | 否 | DESC | 排序方式:
|
OrderField | String | 否 | gmt_create | 用于排序的字段:
|
PageNo | Integer | 否 | 1 | 页码数,最小值为1。 |
PageSize | Integer | 否 | 10 | 每页显示的条数,默认为10条,最大为20条。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
Success | Boolean | true | 调用是否成功。
|
ErrorCode | String | 400 | 错误码。 |
ErrorMessage | String | 缺少参数 | 错误信息。 |
HttpStatusCode | Integer | 400 | HTTP返回码。 |
Data | Any | 1234 | 返回数据。 |
RequestId | String | 900000001 | 请求ID,一次请求的唯一标识。 |
DynamicErrorCode | String | 400 | 错误码。取值同ErrorCode。 |
DynamicErrorMessage | String | 缺少参数 | 错误信息。取值同ErrorMessage。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DsgQuerySensResult
&TenantId=10241024
&DbType=ODPS.ODPS
&ProjectName=project
&SchemaName=schema
&Table=table
&Col=col
&NodeName=个人信息
&Level=3
&SensStatus=1
&SensitiveId=10241024
&SensitiveName=姓名
&Order=DESC
&OrderField=gmt_create
&PageNo=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DsgQuerySensResultResponse>
<Success>true</Success>
<ErrorCode>400</ErrorCode>
<ErrorMessage>缺少参数</ErrorMessage>
<HttpStatusCode>400</HttpStatusCode>
<Data>1234</Data>
<RequestId>900000001</RequestId>
<DynamicErrorCode>400</DynamicErrorCode>
<DynamicErrorMessage>缺少参数</DynamicErrorMessage>
</DsgQuerySensResultResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Success" : true,
"ErrorCode" : "400",
"ErrorMessage" : "缺少参数",
"HttpStatusCode" : 400,
"Data" : "1234",
"RequestId" : "900000001",
"DynamicErrorCode" : "400",
"DynamicErrorMessage" : "缺少参数"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | BADPARAMETERS | Parameters are missing or in the wrong format. | 缺少参数 |
访问错误中心查看更多错误码。