文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据库水印/ 新建数据水印提取任务,转发数据水印提取任务并更新任务参数 - CreateDbExtractTask
更新时间:2026-11-13 GMT+08:00
分享

新建数据水印提取任务,转发数据水印提取任务并更新任务参数 - CreateDbExtractTask

功能介绍

功能介绍:新建数据水印提取任务,指定待提取水印的数据库表、字段及水印参数,任务执行后返回提取结果。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/data-watermark-extract-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 FormData参数

参数

是否必选

参数类型

描述

file

是

File

参数解释:

待提取水印的数据文件,必须为csv格式文件。

约束限制:

文件大小不能超过最大限制(20MB)

取值范围:

不涉及

默认取值:

不涉及

task_name

是

String

参数解释:

水印提取任务名称。

约束限制:

必须以中文、字母、数字、下划线、横线组成

取值范围:

字符串类型,长度1~255字符

默认取值:

不涉及

file_separator

是

String

参数解释:

csv文件分隔符,用于解析csv文件的字段分隔字符。

约束限制:

长度必须为1个字符

取值范围:

单字符,如逗号(,)、制表符(\t)等

默认取值:

不涉及

extract_mode

是

String

参数解释:

水印提取模式,按行提取或按列提取。

约束限制:

仅支持ROW、COLUMN两种模式

取值范围:

  • ROW-按行提取

  • COLUMN-按列提取

默认取值:

COLUMN

description

否

String

参数解释:

任务描述信息。

约束限制:

不涉及

取值范围:

字符串类型,长度0~255字符

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求处理状态,标识任务的执行结果

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

被删除的水印嵌入任务对应的资源ID

取值范围:

不涉及

请求示例

{
  "file" : "extract-data.csv",
  "task_name" : "extract-task-01",
  "file_separator" : ",",
  "extract_mode" : "COLUMN",
  "description" : "客户数据水印提取任务"
}

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "新建数据水印提取任务,转发数据水印提取任务并更新任务参数成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

更新成功

错误码

请参见错误码。

相关文档