文档首页/ 数据安全中心 DSC/ API参考/ API说明/ 元数据与资产目录/ 创建元数据扫描任务
更新时间：2025-08-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建元数据扫描任务

功能介绍

该接口用于创建新的元数据扫描任务。支持通过指定任务名称、数据源、调度类型、扫描配置等参数，创建一个可执行的元数据扫描任务。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/metadata/task-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，用于标识具体的项目

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

create_user

否

String

创建者

data_sources

否

Array of DataSource objects

数据源列表

delete_failed_meta

否

Boolean

是否删除失败的元数据

scan_config

否

ScanConfig object

扫描配置信息

schedule_switch

否

Boolean

调度开关

schedule_type

否

String

调度类型

start_now

否

Boolean

是否立即启动

start_time

否

Long

启动时间

task_description

否

String

任务描述

task_name

否

String

任务名称
表3 DataSource

参数

是否必选

参数类型

描述

db_type

否

String

数据库类型

ins_id

否

String

实例ID
表4 ScanConfig

参数

是否必选

参数类型

描述

scan_column_constraints

否

Boolean

是否扫描列约束

scan_comment

否

Boolean

是否扫描注释

scan_privileges

否

Boolean

是否扫描权限

scan_system_db

否

Boolean

是否扫描系统数据库

scan_tables

否

Boolean

是否扫描表

scan_views

否

Boolean

是否扫描视图

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

id

String

任务ID

msg

String

操作状态消息

status

String

操作状态

状态码：201

Created

请求示例

POST /v1/{project_id}/metadata/task-templates

{
  "create_user" : "string",
  "data_sources" : [ { } ],
  "delete_failed_meta" : true,
  "scan_config" : { },
  "schedule_switch" : true,
  "schedule_type" : "string",
  "start_now" : true,
  "start_time" : 0,
  "task_description" : "string",
  "task_name" : "string"
}

响应示例

无

状态码

状态码

描述

200

OK

201

Created

401

未授权，用户未登录或令牌无效

403

无权限访问该资源

404

指定的项目不存在

错误码

请参见错误码。

相关文档