Retrieve sensitive data identification results from Data Security Guard.
Operation description
This API retrieves sensitive data identification results for a specified tenant, mirroring the query functionality in the Data Security Guard console.
Filter results by dimensions such as data source type and workspace.
Sort results by a specific column in ascending or descending order.
Paginate the query results.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TenantId |
string |
Yes |
To obtain the tenant ID, log on to the DataWorks console, go to the DataStudio page, click your username in the upper-right corner, and then choose Menu > User Info. |
10241024 |
| DbType |
string |
No |
The type of the data source. Valid values:
|
ODPS.ODPS |
| ProjectName |
string |
No |
The name of the DataWorks workspace. You can find this on the workspace configuration page in the DataWorks console. |
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 column. |
col |
| NodeName |
string |
No |
The name of the classification node. |
Personal information |
| Level |
string |
No |
The sensitivity level of the column. |
3 |
| SensStatus |
string |
No |
The sensitivity status of the column. Valid values: |
1 |
| SensitiveId |
string |
No |
The ID of the sensitive column. |
10241024 |
| SensitiveName |
string |
No |
The name of the sensitive column. |
name |
| Order |
string |
No |
The sort order. Valid values:
|
DESC |
| OrderField |
string |
No |
The column by which to sort the results. Valid values:
|
gmt_create |
| PageNo |
integer |
No |
The page number. Minimum value: 1. |
1 |
| PageSize |
integer |
No |
The page size. Default value: 10. Maximum value: 20. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| Success |
boolean |
Indicates whether the request succeeded.
|
true |
| ErrorCode |
string |
The error code. |
400 |
| ErrorMessage |
string |
The error message. |
Missing parameter |
| HttpStatusCode |
integer |
The HTTP status code. |
400 |
| Data |
any |
The returned data. |
1234 |
| RequestId |
string |
A unique identifier for this request. |
900000001 |
| DynamicErrorCode |
string |
This parameter has the same value as the |
400 |
| DynamicErrorMessage |
string |
This parameter has the same value as the |
Missing parameter |
Examples
Success response
JSON format
{
"Success": true,
"ErrorCode": "400",
"ErrorMessage": "Missing parameter",
"HttpStatusCode": 400,
"Data": "1234",
"RequestId": "900000001",
"DynamicErrorCode": "400",
"DynamicErrorMessage": "Missing parameter"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | BADPARAMETERS | Parameters are missing or in the wrong format. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.