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

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

Function

This API is used to obtain the top 10 hit rules in the sensitive data identification result.

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.

job_id

Yes

String

Sensitive data identification task ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Page.

limit

No

Integer

Page size.

keyword

No

String

Keyword of a sensitive information object name.

asset_type

No

String

Resource type.

asset_id

No

String

Asset ID.

security_level_ids

No

Array of strings

An array of risk level IDs.

marker

No

Array of strings

Information about the previous/next batch.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of risks.

hit_rule_list

Array of ClassificationHitInfo objects

List of risk statistics.
Table 4 ClassificationHitInfo

Parameter

Type

Description

rule_id

String

Rule ID.

rule_name

String

Rule name.

count

Integer

Number of associated templates.

top_objects

Array of strings

List of hit objects.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

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 sent.

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

Status code: 400

Invalid request.

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

Status Codes

Status Code

Description

200

Request sent.

400

Invalid request.

Error Codes

See Error Codes.