All Products
Search
Document Center

DataWorks:DsgRunSensIdentify

Last Updated:Nov 21, 2024

Starts a sensitive data identification task in Data Security Guard.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:RunIdentifyOpenapinone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TenantIdstringYes

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
EsMetaParamsarray<object>No

The parameters that you need to configure to scan specified metadata.

objectNo
DbTypestringNo

The type of the data source. Valid values:

  • ODPS.ODPS
  • EMR
  • HOLO.POSTGRES
ODPS.ODPS
ClusterIdstringNo

The cluster ID. You can obtain the ID based on the data source you use.

101010
ProjectNamestringNo

The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the name.

1666676756691024
SchemaNamestringNo

The name of the schema.

default
TableNamestringNo

The name of the table.

table1
TableNameListarrayNo

The names of the tables.

stringNo

The name of the table.

table1,table2
UserstringNo

The username of the operator. We recommend that you enter the username of your Alibaba Cloud account.

xxx-uat
InstanceIdlongNo

The instance ID. You can obtain the ID based on the data source you use.

hgprecn-cn-9lb37k181024

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ErrorCodestring

The error code.

9990030003
ErrorMessagestring

The error message.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Dataany

The ID of the generated sensitive data identification task. The value is of the INT 64 type.

1000001
HttpStatusCodeinteger

The HTTP status code.

400
RequestIdstring

The request ID.

10000001

Examples

Sample success responses

JSONformat

{
  "ErrorCode": "9990030003",
  "ErrorMessage": "",
  "Success": true,
  "Data": "1000001",
  "HttpStatusCode": 400,
  "RequestId": "10000001"
}

Error codes

HTTP status codeError codeError message
400BADPARAMETERSParameters are missing or in the wrong format.

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