Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Obtaining the Top 10 Matched Rules in the Sensitive Data Identification Result
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Top 10 Matched Rules in the Sensitive Data Identification Result

Function

This API is used to obtain the top 10 matched rules in the sensitive data identification result based on the specified task ID and project ID. The rule information includes the rule ID, name, matching times, and sensitive information object.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/scan-jobs/{job_id}/hit-rules

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 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 matched rule objects.

hit_rule_list

Array of ClassificationHitInfo objects

List of matched rules, including detailed statistics of each rule.
Table 4 ClassificationHitInfo

Parameter

Type

Description

rule_id

String

Rule ID, which uniquely identifies a rule. If the LLM template is used for scanning, the value of rule_id in the returned result is the same as that of rule_name.

rule_name

String

Rule name, which is used to identify and manage rules.

count

Integer

Number of matched objects.

top_objects

Array of strings

List of matched objects, that is, the sensitive objects that match the rule.

Status code: 400

Table 5 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 top 10 hit rules in the sensitive data identification result.

GET /v1/{project_id}/scan-jobs/{job_id}/hit-rules

Example Responses

Status code: 200

Request succeeded. Information about the top 10 matched rules is returned.

{
  "hit_rule_list" : [ {
    "rule_id" : "xxxxxxxxxxxx",
    "rule_name" : "xxxxxxxxxxxx",
    "count" : 5,
    "top_objects" : [ "xxxx", "xxxxxxx" ]
  } ],
  "total" : 1
}

Status code: 400

Invalid request. Incorrect parameter format or content.

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

Status Codes

Status Code

Description

200

Request succeeded. Information about the top 10 matched rules is returned.

400

Invalid request. Incorrect parameter format or content.

Error Codes

See Error Codes.