DsgRunSensIdentify-DataWorks(DataWorks)-阿里云帮助中心

Starts a sensitive data identification task in Data Security Guard (DSG).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:RunIdentifyOpenapi

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	The tenant ID. To obtain the tenant ID, log on to the DataWorks console, find your workspace, and go to the DataStudio page. Click your username in the upper-right corner and click User Info in the Menu section.	10241024
EsMetaParams	array<object>	No	The parameters for scanning specified metadata.
	object	No	The parameters for scanning a specific metadata entry.
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 view the workspace name on the Workspace page of the DataWorks console.	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 use the username of your Alibaba Cloud account.	xxx-uat
InstanceId	integer	No	The instance ID. You can obtain the ID based on the data source you use.	hgprecn-cn-9lb37k181024

Response elements

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

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.