All Products
Search
Document Center

DataWorks:GetOpSensitiveData

Last Updated:Nov 21, 2024

Queries the records that are generated on a specified date for access to 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
NamestringYes

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

  • dbType
  • instanceName
  • databaseName
  • projectName
  • clusterName

The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: [ {"dbType":"hologres","instanceName":"ABC","databaseName":"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"} ]
PageSizeintegerYes

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

1
PageNointegerYes

The page number. Minimum value: 1. Maximum value: 1000.

100
DatestringYes

The date on which access records were generated. Specify the value in the yyyyMMdd format.

20210116
OpTypestringNo

The operation that is performed on the data. Valid values:

  • SQL_SELECT: specifies the data access operation. For example, execute a SELECT statement to query data.
  • TUNNEL_DOWNLOAD: specifies the data download operation. For example, run a Tunnel command to download data.
SQL_SELECT

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

OpSensitiveDatastring

The information about the access records of the sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:

  • sensType: the type of the sensitive data.
  • sensLevel: the sensitivity level of the sensitive data. A larger value indicates a higher sensitivity level.
  • opType: the type of the operation.
  • sql: the SQL statement that is executed.
  • opAccount: the account that is used to perform the operation.
  • opTime: the time when the operation was performed.
RequestIdstring

The request ID.

0000-ABCD-EFG****

Examples

Sample success responses

JSONformat

{
  "OpSensitiveData": "",
  "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