Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Identification/ Obtaining the Classification and Grading Templates for Sensitive Data Identification
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Classification and Grading Templates for Sensitive Data Identification

Function

This API is used to obtain the list of classification and grading templates for sensitive data identification based on the specified project ID. Pagination query is supported.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/scan-templates

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.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of identification templates.

scan_templates_list

Array of ScanTemplateEntity objects

List of identification templates, including details about each template.
Table 4 ScanTemplateEntity

Parameter

Type

Description

id

String

Identification template ID, which uniquely identifies a template.

project_id

String

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

name

String

Template name, which is used to identify and manage templates.

description

String

Template description, which briefly describes the template function.

category

String

Template category, which is used to classify templates.

is_default

Boolean

Whether the default template is used.

create_time

Long

Timestamp when a template is created.

update_time

Long

Timestamp when a template is last updated.

is_deleted

Boolean

Whether the template is deleted.

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 list of classification and grading templates for sensitive data identification.

GET /v1/{project_id}/scan-templates

Example Responses

Status code: 200

Request succeeded. The template list is returned.

{
  "scan_templates_list" : [ {
    "id" : "xxxxxxxxxxxx",
    "project_id" : "xxxxxxxxxxxx",
    "name" : "xxxxxxxxxxxx",
    "description" : "xxxxxxxxxxxx",
    "category" : "BUILT_IN",
    "is_default" : true,
    "create_time" : 1710560820120,
    "update_time" : 1710573345350,
    "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

Request succeeded. The template list is returned.

400

Invalid request. Incorrect parameter format or content.

Error Codes

See Error Codes.