DsgRunSensIdentify - DataWorks - Alibaba Cloud Documentation Center

Starts a sensitive data identification task in Data Security Guard.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:RunIdentifyOpenapi	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	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
EsMetaParams	array<object>	No	The parameters that you need to configure to scan specified metadata.
	object	No
DbType	string	No	The type of the data source. Valid values: ODPS.ODPS EMR HOLO.POSTGRES	ODPS.ODPS
ClusterId	string	No	The cluster ID. You can obtain the ID based on the data source you use.	101010
ProjectName	string	No	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
SchemaName	string	No	The name of the schema.	default
TableName	string	No	The name of the table.	table1
TableNameList	array	No	The names of the tables.
	string	No	The name of the table.	table1,table2
User	string	No	The username of the operator. We recommend that you enter the username of your Alibaba Cloud account.	xxx-uat
InstanceId	long	No	The instance ID. You can obtain the ID based on the data source you use.	hgprecn-cn-9lb37k181024

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
ErrorCode	string	The error code.	9990030003
ErrorMessage	string	The error message.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	any	The ID of the generated sensitive data identification task. The value is of the INT 64 type.	1000001
HttpStatusCode	integer	The HTTP status code.	400
RequestId	string	The request ID.	10000001

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	BADPARAMETERS	Parameters are missing or in the wrong format.

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