QuerySensNodeInfo -

Queries sensitive data identification rules in Data Security Guard.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	QuerySensNodeInfo	The operation that you want to perform. Set the value to QuerySensNodeInfo.
TemplateId	String	Yes	e1970541-6cf5-4d23-b101-d5b66f6e1024	The ID of the data category and data sensitivity level template. You can call the QueryDefaultTemplate operation to obtain the template ID.
TenantId	String	Yes	10241024	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.
NodeId	String	No	0ce67949-0810-400f-a24a-cc5ffafe1024	The ID of the data category. 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.
SensitiveName	String	No	ID card number	The name of the sensitive field. You can log on to the DataWorks console and go to the Data Security Guard page to obtain the name.
PageNo	Integer	No	1	The page number. Pages start from page 1.
PageSize	Integer	No	10	The number of entries per page. Valid values: 10 to 1000. The recommended number of entries per page ranges from 10 to 100.
status	Integer	No	0	The status of the sensitive field. Valid values: 0: draft 1: published

Response parameters

Parameter	Type	Example	Description
Success	Boolean	true	Indicates whether the request was successful. true false
ErrorCode	String	9990030003	The error code.
ErrorMessage	String	A required parameter is not specified.	The error message.
HttpStatusCode	Integer	200	The HTTP status code.
Data	Any	{ "success": true, "httpStatusCode": 200, "data": { "result": [ { "sensitiveName": "Expiry date of certificates", "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12", "status": 0, "templateName": "Built-in data category and data sensitivity level template", "keyRuleId": "228248921215042 Expiry date of certificates" } ], "totalCount": 1, "currentPage": 1, "pageSize": 10 }, "requestId": 10000001 }	The returned business data in the JSON format.
RequestId	String	10000001	The request ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=QuerySensNodeInfo
&TemplateId=e1970541-6cf5-4d23-b101-d5b66f6e1024
&TenantId=10241024
&NodeId=0ce67949-0810-400f-a24a-cc5ffafe1024
&SensitiveName=ID card number
&PageNo=1
&PageSize=10
&status=0
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<QuerySensNodeInfoResponse>
    <Success>true</Success>
    <ErrorCode>9990030003</ErrorCode>
    <ErrorMessage>A required parameter is not specified.</ErrorMessage>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>{     "success": true,     "httpStatusCode": 200,     "data": {         "result": [                         {                 "sensitiveName": "Expiry date of certificates",                 "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12",                 "status": 0,                 "templateName": "Built-in data category and data sensitivity level template",                  "keyRuleId": "228248921215042 Expiry date of certificates"             }         ],         "totalCount": 1,         "currentPage": 1,         "pageSize": 10     },     "requestId": 10000001 }</Data>
    <RequestId>10000001</RequestId>
</QuerySensNodeInfoResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "ErrorCode" : "9990030003",
  "ErrorMessage": "A required parameter is not specified.",
  "HttpStatusCode" : 200,
  "Data" : "{     \"success\": true,     \"httpStatusCode\": 200,     \"data\": {         \"result\": [                         {                 \"sensitiveName\": \"Expiry date of certificates\",                 \"sensitiveId\": \"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\",                 \"status\": 0,                 \"templateName\": \"Built-in data category and data sensitivity level template\",                  \"keyRuleId\": \"228248921215042 Expiry date of certificates\"             }         ],         \"totalCount\": 1,         \"currentPage\": 1,         \"pageSize\": 10     },     \"requestId\": 10000001 }",
  "RequestId" : "10000001"
}

Error codes

HttpCode	Error code	Error message	Description
400	BADPARAMETERS	Parameters are missing or in the wrong format.	A required parameter is not specified.

For a list of error codes, see Service error codes.