文档首页/ 数据安全中心 DSC/ API参考/ API/ 识别规则/ 批量导入规则 - ImportScanRules
更新时间:2026-10-20 GMT+08:00
分享

批量导入规则 - ImportScanRules

功能介绍

功能介绍:通过模板文件批量导入识别规则。 关键参数说明:需上传ti_file文件(不超过5M),template_id和template_type可选。 返回值说明:返回导入状态、成功消息及错误明细。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/scan-rules/import-template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识用户在数据安全中心控制台中创建的项目

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 FormData参数

参数

是否必选

参数类型

描述

ti_file

是

File

参数解释:

ti文件,用于批量导入扫描规则的模板文件,支持.xlsx等通用文件格式

约束限制:

不涉及

取值范围:

文件类型

默认取值:

不涉及

template_id

否

String

参数解释:

识别模板ID,标识批量导入规则的识别模板,可通过查询模板列表接口获取

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

template_type

否

String

参数解释:

模板类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态

取值范围:

不涉及

success_msg

String

参数解释:

成功消息

取值范围:

不涉及

error_response

Error object

参数解释:

错误响应

取值范围:

不涉及

表5 Error

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

error_messages

Array of LineMessage objects

参数解释:

错误消息

取值范围:

不涉及

line_number

Integer

参数解释:

行号

取值范围:

不涉及

message

String

参数解释:

消息

取值范围:

不涉及

表6 LineMessage

参数

参数类型

描述

line_number

Integer

参数解释:

行号,标识错误数据所在文件的行号

取值范围:

整数

message

String

参数解释:

错误消息

取值范围:

不涉及

请求示例

批量导入规则

{ }

响应示例

状态码:200

{
  "status" : "FINISHED",
  "success_msg" : "scan-template-01",
  "error_response" : {
    "total" : 100,
    "error_messages" : [ {
      "line" : 1,
      "error_message" : "scan-template-01"
    }, {
      "line" : 1,
      "error_message" : "scan-template-01"
    } ],
    "line_number" : 10,
    "message" : "scan-template-01"
  }
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档