QueryRecognizeRuleDetail -

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	QueryRecognizeRuleDetail	The operation that you want to perform. Set the value to QueryRecognizeRuleDetail.
SensitiveName	String	No	Name	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.
TenantId	String	No	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.

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	{"nodeName":"Basic company profile","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"","defineType":1,"ydAccuracy":1,"contentRule":{"contentRule":{},"operationType":0},"nodeParent":"Company/Basic company information/Basic company profile","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}	The details of the sensitive field in the JSON format.
RequestId	String	10000001	The request ID. You can locate logs and troubleshoot issues based on the ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=QueryRecognizeRuleDetail
&SensitiveName=Name
&TenantId=10241024
&<Common request parameters>

Sample success responses

XML format

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

<QueryRecognizeRuleDetailResponse>
    <Success>true</Success>
    <ErrorCode>9990030003</ErrorCode>
    <ErrorMessage>A required parameter is not specified.</ErrorMessage>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>{"nodeName":"Basic company profile","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"","defineType":1,"ydAccuracy":1,"contentRule":{"contentRule":{},"operationType":0},"nodeParent":"Company/Basic company information/Basic company profile","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}</Data>
    <RequestId>10000001</RequestId>
</QueryRecognizeRuleDetailResponse>

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": "{\"nodeName\":\"Basic company profile\",\"gmtModified\":1709017449000,\"hitThreshold\":30,\"sensitiveName\":\"mobile-yinni\",\"templateId\":\"8222abeb-9784-4417-b420-0322926d5cbf\",\"recognizeRulesType\":2,\"delete\":false,\"bydAccuracy\":1,\"colScan\":\"\",\"defineType\":1,\"ydAccuracy\":1,\"contentRule\":{\"contentRule\":{},\"operationType\":0},\"nodeParent\":\"Company/Basic company information/Basic company profile\",\"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" : "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.