文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据水印/ 获取水印嵌入任务列表 - ListDbEmbedTasks
更新时间:2026-10-09 GMT+08:00
分享

获取水印嵌入任务列表 - ListDbEmbedTasks

功能介绍

功能介绍:获取水印嵌入任务列表

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/data-watermark-embed-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

Long

参数解释:

资源ID,唯一标识

取值范围:

最小值0,最大值2147483647

task_name

String

参数解释:

数据库水印嵌入响应名称

取值范围:

不涉及

schedule_type

String

参数解释:

数据库水印嵌入响应类型

取值范围:

  • ONCE-单次

  • DAY-每天

  • WEEK-每周

  • MONTH-每月

task_start_time

Long

参数解释:

任务开始时间

取值范围:

最小值0,最大值2147483647

start_now

Integer

参数解释:

是否立即执行

取值范围:

最小值0,最大值2147483647

error_code

String

参数解释:

数据库水印嵌入响应码

取值范围:

不涉及

water_mark

String

参数解释:

水印内容

取值范围:

不涉及

watermark_version

String

参数解释:

水印版本

取值范围:

不涉及

target_db_info

DbWatermarkParam object

参数解释:

目标数据库信息

取值范围:

不涉及

result

Array of TaskDetail objects

参数解释:

嵌入任务结果列表

取值范围:

不涉及

total_num

Long

参数解释:

数据库水印嵌入响应数量

取值范围:

最小值0,最大值2147483647

db_water_param

String

参数解释:

数据库水印参数

取值范围:

不涉及

error_msg

String

参数解释:

错误信息

取值范围:

不涉及

schedule_switch

Boolean

参数解释:

调度开关

取值范围:

true-是,false-否

selected_fields

Array of strings

选定字段

start_time

Long

参数解释:

开始时间

取值范围:

不涉及

task_create_time

Long

参数解释:

任务创建时间

取值范围:

不涉及

task_end_time

Long

参数解释:

任务结束时间

取值范围:

不涉及

task_state

String

参数解释:

任务状态

取值范围:

不涉及

watermark_describe

String

参数解释:

水印描述

取值范围:

不涉及

表4 DbWatermarkParam

参数

参数类型

描述

params

Array of EmbedParam objects

参数解释:

嵌入参数列表

取值范围:

不涉及

watermark_key

String

参数解释:

数据库水印参数密钥

取值范围:

不涉及

embed_mode

String

参数解释:

数据库水印参数模式

取值范围:

不涉及

row_spacing

String

参数解释:

行间距

取值范围:

不涉及

表5 EmbedParam

参数

参数类型

描述

column_name

String

参数解释:

嵌入参数名称

取值范围:

不涉及

watermark_value

String

参数解释:

水印值

取值范围:

不涉及

fake_param

String

参数解释:

伪装参数

取值范围:

不涉及

fake_strategy

String

参数解释:

伪装策略

取值范围:

不涉及

new_column_name

String

参数解释:

新列名

取值范围:

不涉及

new_column_type

String

参数解释:

新列类型

取值范围:

不涉及

表6 TaskDetail

参数

参数类型

描述

id

Long

参数解释:

资源ID,唯一标识

取值范围:

不涉及

task_name

String

参数解释:

任务详情名称

取值范围:

不涉及

schedule_type

String

参数解释:

任务详情类型

取值范围:

不涉及

start_time

Long

参数解释:

任务详情时间

取值范围:

不涉及

start_now

Boolean

参数解释:

是否立即开始

取值范围:

true-是,false-否

schedule_switch

Boolean

参数解释:

是否启用调度

取值范围:

true-是,false-否

task_state

String

参数解释:

任务详情状态

取值范围:

不涉及

error_msg

String

参数解释:

错误信息

取值范围:

不涉及

task_end_time

Long

参数解释:

任务详情时间

取值范围:

不涉及

task_create_time

Long

参数解释:

任务详情时间

取值范围:

不涉及

error_code

Integer

参数解释:

任务详情码

取值范围:

不涉及

water_mark

String

参数解释:

水印内容

取值范围:

不涉及

watermark_version

String

参数解释:

水印版本

取值范围:

不涉及

watermark_describe

String

参数解释:

水印描述

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "id" : 1001,
  "task_name" : "embed-task-01",
  "schedule_type" : "ONCE",
  "task_start_time" : 1700000000000,
  "start_now" : 1,
  "error_code" : "DSC.00000000",
  "water_mark" : "dsc-embed-watermark-01",
  "watermark_version" : "VERSION_1",
  "target_db_info" : {
    "params" : [ {
      "column_name" : "phone",
      "watermark_value" : "asset-owner-001"
    } ],
    "watermark_key" : "dsc-wm-key-01",
    "embed_mode" : "EMBED_FAKE_ROW",
    "row_spacing" : "100"
  },
  "result" : [ {
    "id" : 1001,
    "task_name" : "embed-task-01",
    "schedule_type" : "ONCE",
    "start_time" : 1700000000000,
    "start_now" : true,
    "schedule_switch" : true,
    "task_state" : "FINISHED",
    "error_msg" : "任务执行成功",
    "task_end_time" : 1700000600000,
    "task_create_time" : 1700000000000,
    "error_code" : 0,
    "water_mark" : "dsc-embed-watermark-01",
    "watermark_version" : "VERSION_1",
    "watermark_describe" : "客户数据水印嵌入"
  } ],
  "total_num" : 1
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档