Use QueryRecognizeDataByRuleType to get the type of a sensitive data identification rule - DataWorks - Alibaba Cloud - DataWorks

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:QueryRecognizeDataByRuleType

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RecognizeRulesType	string	Yes	The recognition rule type. You can call the QueryRecognizeRulesType operation to obtain the rule types. 1: regular expression 2: built-in model 3: sample library 4: auto-generated model	2
TenantId	string	Yes	The tenant ID. Log on to the DataWorks console, go to the DataStudio page, click the username in the upper-right corner, and choose Menu > User Info to obtain the tenant ID. You can also obtain the tenant ID from Data.TenantId in the response of the GetProject operation.	10241024

Response elements

Element	Type	Description	Example
	object	The response data.
ErrorCode	string	The error code.	9990030003
ErrorMessage	string	The error message.	Missing parameter
Success	boolean	Indicates whether the call was successful. true: Successful. false: Failed.	true
Data	any	The returned data in JSON format.	[{"custom": false, "name": "EducationDegree", "localeName": "EducationDegree", "templateJsonStr": "{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}", "desc": ""}]
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	100000012

Examples

Success response

JSON format

{
  "ErrorCode": "9990030003",
  "ErrorMessage": "Missing parameter",
  "Success": true,
  "Data": "[{\"custom\": false,       \"name\": \"EducationDegree\",       \"localeName\": \"EducationDegree\",       \"templateJsonStr\": \"{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}\",       \"desc\": \"\"}]",
  "HttpStatusCode": 200,
  "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.