Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Obtaining Details About Sensitive Data Classification Results

Updated on 2026-01-13 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining Details About Sensitive Data Classification Results

Function

This API is used to obtain details about sensitive data classification results based on the specified task ID and project ID. Pagination query and keyword filtering are supported.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/scan-jobs/{job_id}/classification-results

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used to identify a specific project.
job_id	Yes	String	Sensitive data identification task ID, which is used to identify a specific scan task.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Page number, which is used for pagination query. The default value is 0.
limit	No	Integer	Page size, which is used to limit the number of results returned on each page. The default value is 100.
keyword	No	String	Keyword of the sensitive information object name, which is used for fuzzy search.
asset_type	No	String	Resource type, which is used to filter results.
asset_id	No	String	Asset ID, which is used to filter results.
security_level_ids	No	Array of strings	Risk level ID array, which is used to filter results.
marker	No	Array of strings	Information about the previous or next batch, which is used for pagination query.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Total number of identification results.
classification_list	Array of ClassificationResultsEntity objects	List of identification result objects, including details about each identification result.
marker	Array of objects	Batch result, which is used to identify the end position of the current batch during pagination query.

**Table 4** ClassificationResultsEntity
Parameter	Type	Description
id	String	Result flag, which uniquely identifies the identification result.
project_id	String	Project ID, which is used to identify a specific project.
job_id	String	Task ID, which is used to identify a specific task.
task_id	String	Subtask ID, which is used to identify a specific subtask.
ins_id	String	Instance ID, which is used to identify a specific instance.
asset_id	String	Asset ID, which is used to identify an asset.
asset_name	String	Asset name, which is used to identify and manage assets.
asset_type	String	Asset type, such as OBS, DATABASE, and BIGDATA.
object_name	String	Name of the object in an asset.
object_full_path	String	Complete path of the object in an asset.
security_level_name	String	Identification result level name, which indicates the risk level name of the asset.
security_level_id	String	Identification result level ID, which indicates the risk level ID of the asset.
security_level_color	Integer	Risk level color of the identification result, which is displayed on the GUI.
create_time	Long	Timestamp when the identification result is created.
update_time	Long	Timestamp when the identification result is last updated.
scan_time	Long	Time when the identification starts.
match_info	Array of ClassificationMatchInfo objects	List of matched rules, including all matched rules in the asset and their details.

**Table 5** ClassificationMatchInfo
Parameter	Type	Description
template_id	String	Identification template ID, which uniquely identifies a template.
template_name	String	Identification template name, which is used to identify and manage templates.
rule_id	String	Rule ID, which uniquely identifies a rule.
rule_name	String	Rule name, which is used to identify and manage rules.
security_level_name	String	Identification result level name, which indicates the risk level name identified by the rule.
security_level_id	String	Identification result level ID, which indicates the risk level ID identified by the rule.
security_level_color	Integer	Risk level color of the identification result, which is displayed on the GUI.
classification_name	String	Classification and grading name, which indicates the name of the category to which a rule belongs.
classification_id	String	Classification and grading ID, which indicates the ID of the category to which a rule belongs.
matched_detail	String	Matching details, which indicate the specific content and position matched by the rule.
matched_examples	Array of MatchedExamples objects	List of matching rules, which includes examples of content matched by the rule.

**Table 6** MatchedExamples
Parameter	Type	Description
line_number	Long	Number of rows, which indicates the specific position of the matched content in the file.
matched_content	String	Rule content, which indicates the matched content.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which uniquely identifies an error type.
error_msg	String	Error information, which describes the error details.

Example Requests

Obtain the classification and grading result details of sensitive data identification.

GET /v1/{project_id}/scan-jobs/{job_id}/classification-results

Example Responses

Status code: 200

The request is successful, and the classification result list is returned.

{
  "classification_list" : [ {
    "id" : "xxxxxxxxxxxx",
    "project_id" : "xxxxxxxxxxxx",
    "job_id" : "xxxxxxxxxxxx",
    "task_id" : "xxxxxxxxxxxx",
    "ins_id" : "xxxxxxxxxxxx",
    "asset_id" : "xxxxxxxxxxxx",
    "asset_name" : "xxxxxxxxxxxx",
    "asset_type" : "OBS",
    "object_name" : "xxxxxxxxxxxx",
    "object_full_path" : "xxxxxxxxxxxx",
    "security_level_name" : "L4",
    "security_level_id" : "xxxxxxxxxxxx",
    "security_level_color" : 4,
    "create_time" : 1710560820120,
    "update_time" : 1710573345350,
    "scan_time" : 12293,
    "match_info" : [ {
      "template_id" : "xxxxxxxxxxxx",
      "template_name" : "xxxxxxxxxxxx",
      "rule_id" : "xxxxxxxxxxxx",
      "rule_name" : "xxxxx",
      "security_level_name" : "L4",
      "security_level_id" : "xxxxxxxxxxxx",
      "security_level_color" : 5,
      "classification_name" : "xxxxxxxxxxxx",
      "classification_id" : "xxxxxxxxxxxx",
      "matched_detail" : "xxx"
    } ]
  } ],
  "total" : 1,
  "marker" : [ { }, { } ]
}

Status code: 400

Invalid request. Incorrect parameter format or content.

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code	Description
200	The request is successful, and the classification result list is returned.
400	Invalid request. Incorrect parameter format or content.

Error Codes

See Error Codes.

Parent topic: Sensitive Data Identification

Previous topic: Obtaining the Top 10 Matched Rules in the Sensitive Data Identification Result

Next topic: Obtaining the Classification and Grading Templates for Sensitive Data Identification

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.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot