创建模板 - CreateScanTemplates
功能介绍
功能介绍:创建识别模板,支持新建或复制已有模板。 关键参数说明:action必填(ADD新建/COPY复制),new_template_name必填(最大255字符);COPY时需指定origin_template_id;template_type可选(TRADITIONAL/LLM,默认TRADITIONAL)。 返回值说明:返回操作状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/scan-templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| action | 是 | String | 参数解释: 操作类型,用于指定创建模板时的操作方式,如新建或基于现有模板复制等 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| origin_template_id | 否 | String | 参数解释: 源模板ID,标识复制创建新模板时的源识别扫描模板,可通过调用查询模板列表接口获取模板ID 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| add_built_in_rules | 否 | Boolean | 参数解释: 是否添加内置规则 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: true |
| new_template_name | 是 | String | 参数解释: 新模板名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| template_type | 否 | String | 参数解释: 模板类型,用于指定创建识别扫描模板的类型 约束限制: 不涉及 取值范围: 默认取值: TRADITIONAL |
| description | 否 | String | 参数解释: 资源描述信息 约束限制: 符合正则匹配"^[a-zA-Z0-9\(\)\(\)\-\_\u4E00-\u9FA5 ]*$" 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
创建模板
{
"action" : "ADD",
"origin_template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
"add_built_in_rules" : true,
"new_template_name" : "scan-template-01",
"template_type" : "TRADITIONAL",
"description" : "scan-template示例描述"
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "创建扫描模板成功",
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。