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

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

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Page.

limit

No

Integer

Page size.

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.
Table 4 ScanTemplateEntity

Parameter

Type

Description

id

String

Identification template ID.

project_id

String

Project ID.

name

String

Template name.

description

String

Template description.

category

String

Template category.

is_default

Boolean

Whether the template is a default template.

create_time

Long

Creation time.

update_time

Long

Update time.

is_deleted

Boolean

Whether to delete the template.

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

GET /v1/{project_id}/scan-templates

Example Responses

Status code: 200

Request sent.

{
  "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.

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

Status Codes

Status Code

Description

200

Request sent.

400

Invalid request.

Error Codes

See Error Codes.