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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetSensitiveData

The operation that you want to perform.

Name String Yes [ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"odps","projectName":"adbc"} ]

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

  • dbType: the data type
  • instanceName: the name of the instance
  • databaseName: the name of the database
  • projectName: the name of the workspace
  • clusterName: the name of the cluster

The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the ABC Hologres instance:

{"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}

You must specify the parameters based on the compute engine that you use in your business.

PageNo Integer Yes 1

The number of the page to return. Minimum value:1.

PageSize Integer Yes 1000

The number of entries to return on each page. Maximum value: 1000.

RegionId String Yes cn-shenzhen

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EFG****

The ID of the request.

SensitiveData Map { "sensDatas": [ { "sensLevel": "L1", "guid": "dsg_demo.animal.dog", "sensType": "Name" } ], "totalCount": 2171 }

The information of 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetSensitiveData
&Name=[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"odps","projectName":"adbc"} ]
&PageNo=1
&PageSize=1000
&RegionId=cn-shenzhen
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<SensitiveData>{      "sensDatas": [       {         "sensLevel": "L1",         "guid": "dsg_demo.animal.dog",         "sensType": "Name"       }      ],     "totalCount": 2171 }</SensitiveData>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "SensitiveData": "{      \"sensDatas\": [       {         \"sensLevel\": \"L1\",         \"guid\": \"dsg_demo.animal.dog\",         \"sensType\": \"Name\"       }      ],     \"totalCount\": 2171 }"
}

Error codes

Http status code Error code Error message Description
403 Forbidden.NoTenant The tenant information cannot be obtained using user ID. The error message returned because the tenant information cannot be obtained.
500 InternalError.DQC.BizError An internal error occurred. The error message returned because an internal server error has occurred.
400 Invalid.Param The request parameter is invalid. The error message returned because one or more request parameters are invalid.

For a list of error codes, visit the API Error Center.