Query sensitive data identification rules with QuerySensNodeInfo - 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:QuerySensNodeInfo

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The ID of the data classification and sensitivity level template. You can call the QueryDefaultTemplate operation to obtain the template ID.	e1970541-6cf5-4d23-b101-d5b66f6e1024
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. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.	10241024
NodeId	string	No	The data classification ID. You can call the QuerySensClassification operation or log on to the DataWorks console and go to the Data Security Guard page to obtain the ID.	0ce67949-0810-400f-a24a-cc5ffafe1024
SensitiveName	string	No	The name of the sensitive field. Log on to the DataWorks console and go to the Data Security Guard page to obtain the name.	ID card
PageNo	integer	No	The page number. Pages start from page 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 10 to 1000. Recommended: 10 to 100.	10
status	integer	No	The status of the sensitive field. Valid values: 0: draft 1: published	0

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 business data returned in JSON format.	{"success": true, "httpStatusCode": 200, "data": { "result": [ { "sensitiveName": "certificate expiration date", "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12", "status": 0, "templateName": "built-in classification and grading template", "keyRuleId": "228248921215042 certificate expiration date"} ], "totalCount": 1, "currentPage": 1, "pageSize": 10 }, "requestId": 10000001}
RequestId	string	The request ID.	10000001

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 200,
  "Data": "{\"success\": true, \"httpStatusCode\": 200, \"data\": { \"result\": [ { \"sensitiveName\": \"certificate expiration date\", \"sensitiveId\": \"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\", \"status\": 0, \"templateName\": \"built-in classification and grading template\", \"keyRuleId\": \"228248921215042 certificate expiration date\"} ], \"totalCount\": 1, \"currentPage\": 1, \"pageSize\": 10 }, \"requestId\": 10000001}",
  "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.