Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Obtaining the List of Sensitive Data Levels
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the List of Sensitive Data Levels

Function

This API is used to obtain the sensitive data level list. The query can be paginated and filtered.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/scan-security-levels

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.
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.

name

No

String

Level name, which is used for fuzzy query.

category

No

String

Level source, which is used to filter results.

is_deleted

No

Boolean

true: Query all levels. false: Query levels that are not disabled.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of risk levels.

security_levels_list

Array of SecurityLevel objects

List of risk levels, including details about each risk level.
Table 4 SecurityLevel

Parameter

Type

Description

level_id

String

Risk level ID, which uniquely identifies a risk level.

project_id

String

Project ID, which is used to identify a specific project.

security_level_name

String

Risk level name.

color_number

Integer

Risk level color, which is displayed on the GUI.

security_level_desc

String

Risk level description.

used_count

Integer

Number of associated identification templates, that is, the number of templates used by the risk level.

category

String

Rule creation type, which is used to distinguish BUILT_IN (built-in rules), BUILT_IN_COPY (built-in rule copies), and BUILT_SELF (user-defined rules).

create_time

Long

Rule creation time, that is, the timestamp when the risk level is created.

update_time

Long

Rule update time, that is, the timestamp when the risk level is last updated.

sort_weight

Integer

Rule sorting, which is used to sort risk levels in the list.

is_deleted

Boolean

Whether the rule is disabled, indicating whether the risk level is disabled.

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 sensitive data level list.

GET /v1/{project_id}/scan-security-levels

Example Responses

Status code: 200

If the request is successful, the sensitive data identification level list is returned.

{
  "security_levels_list" : [ {
    "level_id" : "xxxxxxxxxxxx",
    "project_id" : "xxxxxxxxxxxx",
    "security_level_name" : "L4",
    "color_number" : 4,
    "security_level_desc" : "xxxxx",
    "used_count" : 4,
    "category" : "BUILT_SELF",
    "create_time" : 1710560820120,
    "update_time" : 1710573345350,
    "sort_weight" : 21,
    "is_deleted" : false
  } ],
  "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

If the request is successful, the sensitive data identification level list is returned.

400

Invalid request. Incorrect parameter format or content.

Error Codes

See Error Codes.