文档首页/ 数据安全中心 DSC/ API参考/ API说明/ 敏感数据识别/ 查询敏感数据识别分级分类模板列表
更新时间:2025-08-01 GMT+08:00
分享

查询敏感数据识别分级分类模板列表

功能介绍

根据指定的项目ID,查询敏感数据识别分级分类模板列表,支持分页查询。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/scan-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,用于标识具体的项目。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

页码,用于分页查询,默认值为0。

limit

Integer

分页大小,用于限制每页返回的结果数量,默认值为100。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

识别模板总数,表示模板的总数。

scan_templates_list

Array of ScanTemplateEntity objects

识别模板列表,包含每个模板的详细信息。

表4 ScanTemplateEntity

参数

参数类型

描述

id

String

识别模板ID,用于唯一标识该模板。

project_id

String

项目ID,用于标识具体的项目。

name

String

模板名称,用于标识和管理模板。

description

String

模板描述,对模板功能的简要说明。

category

String

模板分类,用于对模板进行分类管理。

is_default

Boolean

是否默认模板,表示该模板是否为系统默认配置。

create_time

Long

创建时间,表示模板的创建时间戳。

update_time

Long

更新时间,表示模板的最后更新时间戳。

is_deleted

Boolean

是否删除,表示该模板是否已被删除。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,用于唯一标识具体的错误类型。

error_msg

String

错误信息,对错误的详细描述。

请求示例

查询敏感数据识别分级分类模板列表

GET /v1/{project_id}/scan-templates

响应示例

状态码:200

请求成功,返回模板列表。

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

状态码:400

无效请求,参数格式或内容不符合要求。

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

状态码

状态码

描述

200

请求成功,返回模板列表。

400

无效请求,参数格式或内容不符合要求。

错误码

请参见错误码

相关文档