Queries the identification results of sensitive data.
Operation description
The query capability of the API operation is similar to the query feature in Data Security Guard in the DataWorks console. The API operation can be used to query the identification results of sensitive data of a tenant based on the association with the tenant ID.
- You can search for a specific identification result based on filter conditions such as data source type and workspace.
- You can sort the identification results of sensitive data of a tenant based on the values of a field in ascending or descending order.
- This operation supports paged query.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TenantId | string | Yes | The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section. | 10241024 |
DbType | string | No | The type of the database. Valid values:
| ODPS.ODPS |
ProjectName | string | No | The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. | project |
SchemaName | string | No | The name of the schema. | schema |
Table | string | No | The name of the table. | table |
Col | string | No | The name of the field. | col |
NodeName | string | No | The name of a data category. | |
Level | string | No | The sensitivity level of the field. | 3 |
SensStatus | string | No | The sensitivity status of the field.
| 1 |
SensitiveId | string | No | The sensitive field ID. | 10241024 |
SensitiveName | string | No | The name of the sensitive field. | |
Order | string | No | The sorting method.
| DESC |
OrderField | string | No | The field used for sorting.
| gmt_create |
PageNo | integer | No | The page number. Pages start from page 1. | 1 |
PageSize | integer | No | The number of entries per page. Default value: 10. Maximum value: 20. | 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Success": true,
"ErrorCode": "400",
"ErrorMessage": "",
"HttpStatusCode": 400,
"Data": "1234",
"RequestId": "900000001",
"DynamicErrorCode": "400",
"DynamicErrorMessage": ""
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | BADPARAMETERS | Parameters are missing or in the wrong format. |
For a list of error codes, visit the Service error codes.