文档

DescribeDataMaskingRunHistory - 查询脱敏任务执行情况

调用DescribeDataMaskingRunHistory查询脱敏任务执行情况。

接口说明

本接口一般用于获取静态脱敏任务的执行情况,便于您搜索脱敏任务状态和查看任务进度。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sddp:DescribeDataMaskingRunHistoryRead
  • acs:yundun-sddp::{#accountId}:*

请求参数

名称类型必填描述示例值
Langstring

请求和接收消息的语言类型,默认为zh_cn。取值:

  • zh_cn:中文。
  • en_us:英文。
zh_cn
TaskIdstring

脱敏任务的编号。

mt4HBgtw1B******
StartTimelong

按任务执行的起始时间查询,时间戳毫秒格式。

1582992000000
EndTimelong

按任务执行的结束时间查询,时间戳毫秒格式。

1583856000000
Statusinteger

任务执行状态:

  • -1:等待执行。
  • 0:执行中。
  • 1:执行成功。
  • 2:执行失败。
  • 3:用户终止。
  • 4:部分失败。
0
SrcTypeinteger

脱敏数据所属的源产品类型,取值:1:MaxCompute,2:OSS,3:ADS,4:OTS,5:RDS 等。

2
DstTypeinteger

数据脱敏后放置的目标产品类型,取值:1:MaxCompute,2:OSS,3:ADS,4:OTS,5:RDS 等。

2
PageSizeinteger

列表每页显示的最大数据条数。

10
CurrentPageinteger

分页查询时的页码。

1
MainProcessIdlong

主任务 ID。

说明 包含子任务的时候该参数值为当前任务 ID 否则为空。
366731
SrcTableNamestring

源表的表名。

add

返回参数

名称类型描述示例值
object
CurrentPageinteger

结果中显示的当前页的页码。

1
RequestIdstring

结果的请求 ID。

769FB3C1-F4C9-4******
PageSizeinteger

结果中每页显示数据条数。

10
TotalCountinteger

结果中数据的总条数。

100
Itemsobject []

脱敏任务信息列表。

Statusinteger

任务执行状态:

  • -1:等待执行。
  • 0:执行中。
  • 1:执行成功。
  • 2:执行失败。
  • 3:用户终止。
  • 4:部分失败.
1
Typeinteger

执行方式:

  • 1:手工。
  • 2:定时。
1
SrcTypeinteger

脱敏数据所属的源产品类型,取值:1:MaxCompute,2:OSS,3:ADS,4:OTS,5:RDS 等。

2
SrcTableNamestring

源表的表名。

add
MaskingCountlong

脱敏行数。

100
Percentageinteger

执行进度。

100
DstTypeinteger

数据脱敏后放置的目标产品类型,取值:1:MaxCompute,2:OSS,3:ADS,4:OTS,5:RDS 等。

2
FailMsgstring

任务执行失败的原因。

error
FailCodestring

任务执行失败的错误码,只有任务执行失败时才有值。

masking_task_not_found
ConflictCountlong

冲突行数,表示脱敏后待插入目标表的数据和目标表中已有的数据冲突的行数。

0
DstTypeCodestring

目的产品类型。取值:MaxCompute、OSS、ADS、OTS、RDS

OSS
EndTimelong

执行结束时间。

1582251233000
RunIndexinteger

第几次执行该任务。

1
StartTimelong

执行时间,时间戳毫秒格式。

1582251233000
HasSubProcessinteger

已创建的子任务数。

4
HasDownloadFileinteger

是否有下载文件。

  • 1:有。
  • 0:没有。
1
TaskIdstring

任务编号。

mt4HBgtw1B******
SrcTypeCodestring

源产品类型。取值:MaxCompute、OSS、ADS、OTS、RDS

OSS
Idlong

执行记录的 ID。

1

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 100,
  "Items": [
    {
      "Status": 1,
      "Type": 1,
      "SrcType": 2,
      "SrcTableName": "add",
      "MaskingCount": 100,
      "Percentage": 100,
      "DstType": 2,
      "FailMsg": "error",
      "FailCode": "masking_task_not_found",
      "ConflictCount": 0,
      "DstTypeCode": "OSS",
      "EndTime": 1582251233000,
      "RunIndex": 1,
      "StartTime": 1582251233000,
      "HasSubProcess": 4,
      "HasDownloadFile": 1,
      "TaskId": "mt4HBgtw1B******",
      "SrcTypeCode": "OSS",
      "Id": 1
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈