All Products
Search
Document Center

DataWorks:QuerySensClassification

Last Updated:Sep 18, 2024

Queries data categories.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:QuerySensClassificationget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdstringYes

The ID of the template defined by Data Security Guard. You can call the QueryDefaultTemplate operation to obtain the template ID.

e1970541-6cf5-4d23-b101-d5b66f6e1024
TenantIdstringYes

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 parameters

ParameterTypeDescriptionExample
object

The data returned.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

9990030003
ErrorMessagestring

The error message.

HttpStatusCodeinteger

The HTTP status code.

400
Dataany

The returned data about data categories. The data is in the JSON format.

[{ "nodeName": "teset1", "sensitiveNotNull": true, "nodeId": "1aac2e35-b437-486b-95c7-a5ae48371024", "nodeOldId": "1aac2e35-b437-486b-95c7-a5ae48371024", "parentId": "0" }]
RequestIdstring

The request ID.

10000001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "",
  "HttpStatusCode": 400,
  "Data": "[{         \"nodeName\": \"teset1\",         \"sensitiveNotNull\": true,         \"nodeId\": \"1aac2e35-b437-486b-95c7-a5ae48371024\",         \"nodeOldId\": \"1aac2e35-b437-486b-95c7-a5ae48371024\",         \"parentId\": \"0\"     }]",
  "RequestId": "10000001"
}

Error codes

HTTP status codeError codeError message
400BADPARAMETERSParameters are missing or in the wrong format.

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