All Products
Search

This Product

    DataWorks:QueryRecognizeDataByRuleType

    Document Center

    DataWorks:QueryRecognizeDataByRuleType

    Last Updated:Oct 17, 2024

    Queries the type of a sensitive data identification rule.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RecognizeRulesTypestringYes

    The type of a sensitive data identification rule. You can call the QueryRecognizeRulesType operation to obtain the type of the rule.

    • 1: regular expression
    • 2: built-in rule
    • 3: sample library
    • 4: self-generated data identification model
    		2
    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.

    ErrorCodestring

    The error code.

    		9990030003
    ErrorMessagestring

    The error message.

    Successboolean

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    Dataany

    The returned result in the JSON format.

    		[{"custom": false, "name": "EducationDegree", "localeName": "EducationDegree", "templateJsonStr": "{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}", "desc": ""}]
    HttpStatusCodeinteger

    The HTTP status code.

    		200
    RequestIdstring

    The request ID. You can use the ID to locate logs and troubleshoot issues.

    		10000001

    Examples

    Sample success responses

    JSONformat

    {
  "ErrorCode": "9990030003",
  "ErrorMessage": "",
  "Success": true,
  "Data": "[{\"custom\": false,       \"name\": \"EducationDegree\",       \"localeName\": \"EducationDegree\",       \"templateJsonStr\": \"{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}\",       \"desc\": \"\"}]",
  "HttpStatusCode": 200,
  "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.