Use QueryRecognizeRuleDetail to query sensitive field recognition rule details - 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:QueryRecognizeRuleDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SensitiveName	string	Yes	The name of the sensitive field. To obtain the name of the sensitive field, call the QuerySensNodeInfo operation or log on to the DataWorks console and go to the Data Category and Sensitivity Level page.	Name
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

Response elements

Element	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful. true false	true
ErrorCode	string	The error code.	9990030003
ErrorMessage	string	The error message.	Missing parameter
HttpStatusCode	integer	The HTTP status code.	200
Data	any	The details of the sensitive field in the JSON format.	{"nodeName":"basic unit overview","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"," defineType ":1,": ydAccuracy ":{" contentRule ":))," operationType ":0}," nodeParent ":" unit/unit basic information/unit basic overview "," level ":6," keyRuleId ":" 228248921215042mobile-yinni "," isDelete ":false," levelName ":" 6level "," sensitive ":false," operationType ":0," sourceName ": dsg-test-zuoyue","nodeId":"bea2fc81-90c9-45f3-b7a9-26d534208a0d","status":1}
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	10000001

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 200,
  "Data": "{\"nodeName\":\"basic unit overview\",\"gmtModified\":1709017449000,\"hitThreshold\":30,\"sensitiveName\":\"mobile-yinni\",\"templateId\":\"8222abeb-9784-4417-b420-0322926d5cbf\",\"recognizeRulesType\":2,\"delete\":false,\"bydAccuracy\":1,\"colScan\":\",\" defineType \":1,\": ydAccuracy \":{\" contentRule \":)),\" operationType \":0},\" nodeParent \":\" unit/unit basic information/unit basic overview \",\" level \":6,\" keyRuleId \":\" 228248921215042mobile-yinni \",\" isDelete \":false,\" levelName \":\" 6level \",\" sensitive \":false,\" operationType \":0,\" sourceName \": dsg-test-zuoyue\",\"nodeId\":\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\",\"status\":1}",
  "RequestId": "100000012"
}

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.