Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Querying the Classification Tree Structure for Sensitive Data Identification.
Updated on 2025-07-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Classification Tree Structure for Sensitive Data Identification.

Function

This API is used to query the classification tree structure for sensitive data identification.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/scan-templates/{template_id}/classifications

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

template_id

Yes

String

Template ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

template_id

String

Identification template ID.

template_category

String

Identification template category.

template_name

String

Identification template name.

classification_trees

Array of TemplateClassificationTree objects

Classification and grading attribute structure.
Table 3 TemplateClassificationTree

Parameter

Type

Description

id

String

Category ID.

project_id

String

Project ID.

name

String

Category name.

root_id

String

Root category ID.

parent_id

String

Parent category ID.

depth

Integer

Depth.

children_nums

Integer

Total number of sub-categories

create_time

Long

Creation time.

update_time

Long

Update time.

rule_nums

Long

Number of rules.

children

Array of TemplateClassificationTree objects

List of sub-classification and grading.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Query the classification tree structure for sensitive data identification.

GET /v1/{project_id}/scan-templates/{template_id}/classifications

Example Responses

Status code: 200

Request sent.

{
  "template_id" : "xxxxxxxxxxxx",
  "template_category" : "BUILT_IN",
  "template_name" : "xxxxxxxxxxxx",
  "classification_trees" : [ {
    "id" : "xxxxxxxxxxxx",
    "project_id" : "xxxxxxxxxxxx",
    "name" : "xxxxxxxxxxxx",
    "root_id" : "xxxxxxxxxxxx",
    "parent_id" : "",
    "depth" : 1,
    "children_nums" : 1,
    "create_time" : 1686888427971,
    "update_time" : 1686888427971,
    "rule_nums" : 3,
    "children" : [ {
      "id" : "xxxxxxxxxxxx",
      "project_id" : "xxxxxxxxxxxx",
      "name" : "xxxxxxxxxxxx",
      "root_id" : "xxxxxxxxxxxx",
      "parent_id" : "xxxxxxxxxxxx",
      "depth" : 1,
      "children_nums" : 0,
      "create_time" : 1686888427971,
      "update_time" : 1686888427971,
      "rule_nums" : 5,
      "children" : null
    } ]
  } ]
}

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.