All Products
Search
Document Center

DataWorks:GetSensitiveData

Last Updated:Oct 17, 2024

Queries the latest sensitive data in all the DataWorks workspaces of a tenant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerYes

The number of entries per page. Maximum value: 1000.

1000
PageNointegerYes

The page number. Pages start from page 1.

1
NamestringYes

The parameters that you can configure to query the access records. Valid values:

  • dbType
  • instanceName
  • databaseName
  • projectName
  • clusterName

The sample value shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC. You must configure the parameters based on the compute engine that you use in your business.

[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]

Response parameters

ParameterTypeDescriptionExample
object

Response parameters

SensitiveDataobject

The information about the sensitive data returned. The information includes totalCount and sensDatas. sensDatas includes the following parameters:

  • guid: the ID of the metadata of the tenant. For example, the ID of the metadata in the MaxCompute compute engine is in the Project name.Table name.Column name format.
  • sensType: the type of the sensitive data.
  • sensLevel: the sensitivity level of the sensitive data
RequestIdstring

The request ID.

0000-ABCD-EFG****

Examples

Sample success responses

JSONformat

{
  "SensitiveData": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "0000-ABCD-EFG****"
}

Error codes

HTTP status codeError codeError message
400Invalid.ParamThe request parameter is invalid.
403Forbidden.NoTenantThe tenant information cannot be obtained using user ID.
500InternalError.DQC.BizErrorAn internal error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history