You can call this operation to query the running information of de-identification tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDataMaskingRunHistory

The operation that you want to perform.

Set the value to DescribeDataMaskingRunHistory.

Lang String No zh

The language of the request and response. Valid values:

  • zh: Chinese
  • en: English
TaskId String No mt4HBgtw1B******

The ID of the de-identification task.

StartTime Long No 1582992000000

The beginning of the time range to query. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

EndTime Long No 1583856000000

The end of the time range to query. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Status Integer No 0

The status of the de-identification task. Valid values:

  • -1: waiting
  • 0: running
  • 1: successful
  • 2: failed
  • 3: terminated
  • 4: partially failed
SrcType Integer No 2

The type of the service to which the data to be de-identified belongs. Valid values:

  • 1: MaxCompute
  • 2: Object Storage Service (OSS)
  • 5: Relational Database Service (RDS)
DstType Integer No 2

The type of the service that stores the original data to be de-identified after de-identification. Valid values:

  • 1: MaxCompute
  • 2: OSS
  • 5: RDS
PageSize Integer No 10

The number of entries to return on each page.

CurrentPage Integer No 1

The number of the page to return.

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.

Items Array

The list of de-identification tasks that were queried.

ConflictCount Long 0

The number of rows that were in conflict with the data to be de-identified in the destination table to which the data to be de-identified was moved.

DstType Integer 2

The type of the service that stores the original data to be de-identified after de-identification. Valid values:

  • 1: MaxCompute
  • 2: OSS
  • 5: RDS
DstTypeCode String OSS

The type code of the service that stores the original data to be de-identified after de-identification.

FailCode String masking_task_not_found

The error code returned only when the de-identification task failed.

Id Long 1

The ID of the task running record.

MaskingCount Long 100

The number of rows that were de-identified.

Percentage Integer 100

The progress of the de-identification task.

RunIndex Integer 1

The number of times that the de-identification task was run.

SrcType Integer 2

The type of the service to which the data to be de-identified belongs. Valid values:

  • 1: MaxCompute
  • 2: OSS
  • 5: RDS
SrcTypeCode String OSS

The type code of the service to which the data to be de-identified belongs.

StartTime Long 1582251233000

The time when the de-identification task was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Status Integer 1

The status of the de-identification task. Valid values:

  • -1: waiting
  • 0: running
  • 1: successful
  • 2: failed
  • 3: terminated
  • 4: partially failed
TaskId String mt4HBgtw1B******

The ID of the de-identification task.

Type Integer 1

The mode in which the de-identification task was run. Valid values:

  • 1: manual
  • 2: scheduled
PageSize Integer 10

The number of entries returned per page.

RequestId String 769FB3C1-F4C9-4******

The ID of the request.

TotalCount Integer 100

The total number of returned entries.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDataMaskingRunHistory
&<Common request parameters>

Sample success responses

XML format

<DescribeDataMaskingRunHistoryResponse>
  <TotalCount>1</TotalCount>
  <PageSize>5</PageSize>
  <CurrentPage>1</CurrentPage>
  <Items>
        <Status>1</Status>
        <RunIndex>1</RunIndex>
        <TaskId>Vd8Rj80eBXR*****</TaskId>
        <Percentage>100</Percentage>
        <MaskingCount>100000</MaskingCount>
        <StartTime>1582251233000</StartTime>
        <DstTypeCode>RDS</DstTypeCode>
        <ConflictCount>0</ConflictCount>
        <DstType>5</DstType>
        <Type>1</Type>
        <SrcType>1</SrcType>
        <Id>4869</Id>
        <SrcTypeCode>MaxCompute</SrcTypeCode>
  </Items>
  <RequestId>769FB3C1-F4C9-4******</RequestId>
</DescribeDataMaskingRunHistoryResponse>

JSON format

{
    "TotalCount": 1, 
    "PageSize": 5, 
    "CurrentPage": 1, 
    "Items": [
        {
            "Status": 1, 
            "RunIndex": 1, 
            "TaskId": "Vd8Rj80eBXR*****", 
            "Percentage": 100, 
            "MaskingCount": 100000, 
            "StartTime": 1582251233000, 
            "DstTypeCode": "RDS", 
            "ConflictCount": 0, 
            "DstType": 5, 
            "Type": 1, 
            "SrcType": 1, 
            "Id": 4869, 
            "SrcTypeCode": "MaxCompute"
        }
    ], 
    "RequestId": "769FB3C1-F4C9-4******"
}

Error codes

For a list of error codes, visit the API Error Center.