Querying the Diagnosis Result of the Sensitive Data Protection Module

Function

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/diagnose/sensitive-data

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	Diagnosis task ID
scanning	Boolean	Whether a scan is in progress
check_time	Long	Last check time
classification	ClassificationResult object	Data classification and security level diagnosis result
rule	IdentificationRuleResult object	Diagnosis result of sensitive data identification rules
masking	DataMaskingResult object	Data masking diagnosis result

**Table 4** ClassificationResult
Parameter	Type	Description
result	String	detection results NO_RISK MEDIUM_RISK HIGH_RISK NOT_SCANNED
security_level	Boolean	Whether data security levels have been configured
classification	Boolean	Whether data classifications have been configured

**Table 5** IdentificationRuleResult
Parameter	Type	Description
result	String	detection results NO_RISK MEDIUM_RISK HIGH_RISK NOT_SCANNED
count	Integer	Number of risky issues
abnormal_info	Array of SecurityLevelInfo objects	Security levels for which no identification rule has been configured

**Table 6** SecurityLevelInfo
Parameter	Type	Description
name	String	Security level name
level	String	Security level

**Table 7** DataMaskingResult
Parameter	Type	Description
result	String	detection results NO_RISK MEDIUM_RISK HIGH_RISK NOT_SCANNED
count	Integer	Number of tables for which no masking task has been configured

Example Requests

/v1/0833a5737480d53b2f25c010dc1a7b88/security/diagnose/sensitive-data

Example Responses

Status code: 200

{
  "check_time" : 1716435728000,
  "classification" : {
    "classification" : true,
    "result" : "NO_RISK",
    "security_level" : true
  },
  "masking" : {
    "count" : 0,
    "result" : "NO_RISK"
  },
  "rule" : {
    "abnormal_info" : [ {
      "level" : "3",
      "name" : "yyy"
    }, {
      "level" : "8",
      "name" : "Top secret"
    } ],
    "count" : 2,
    "result" : "HIGH_RISK"
  },
  "scanning" : false,
  "task_id" : "695e9ea4dd864e55b5dbdd91ad61ebd0"
}

Status Codes

Status Code	Description
200	OK

Parent Topic: Data Security Diagnosis

Previous topic: Querying the Diagnosis Result of the Data Permission Control Module

Next topic: Querying Tables for Which No Static Masking Task Has Been Performed

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.