You can call this operation to query 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 DescribeDataMaskingTasks

The operation that you want to perform.

Set the value to DescribeDataMaskingTasks.

Lang String No zh

The language of the request and response. Valid values:

  • zh: Chinese
  • en: English
SearchKey String No test

The keyword used to search for the de-identification task, which can be the task name or ID.

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.

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: Object Storage Service (OSS)
  • 5: Relational Database Service (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.

DstPath String ***/table1

The path for storing the original data to be de-identified after de-identification.

DstType Integer 5

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 RDS

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

GmtCreate Long 1582992000000

The time when the de-identification task was created.

HasUnfinishProcess Boolean false

Indicates whether the de-identification task is running.

Id Long 1

The ID of the de-identification task.

Owner String owner

The user who created the de-identification task.

RunCount Integer 1

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

SrcPath String ***/table2

The path of the data to be de-identified before de-identification.

SrcType Integer 5

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

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

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

Status Integer 1

Indicates whether the de-identification task is enabled. Valid values:

  • 0: disabled
  • 1: enabled
TaskId String mt4HBgtw1B******

The ID of the de-identification task.

TaskName String Task name

The name of the de-identification task.

TriggerType Integer 1

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

  • 1: manual
  • 2: scheduled
  • 3: manual and 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=DescribeDataMaskingTasks
&<Common request parameters>

Sample success responses

XML format

<DescribeDataMaskingTasksResponse>
  <RequestId>769FB3C1-F4C9-4******</RequestId>  
  <TotalCount>1</TotalCount>
  <PageSize>5</PageSize>
  <CurrentPage>1</CurrentPage>
  <Items>
        <Status>1</Status>
        <TriggerType>1</TriggerType>
        <Owner>***</Owner>
        <TaskId>mt4HBgtw1B****</TaskId>
        <DstPath>********</DstPath>
        <HasUnfinishProcess>false</HasUnfinishProcess>
        <DstTypeCode>OSS</DstTypeCode>
        <SrcPath>*********</SrcPath>
        <DstType>2</DstType>
        <GmtCreate>1583739870000</GmtCreate>
        <TaskName>Task name</TaskName>
        <SrcType>2</SrcType>
        <RunCount>3</RunCount>
        <Id>1</Id>
        <SrcTypeCode>OSS</SrcTypeCode>
  </Items>
</DescribeDataMaskingTasksResponse>

JSON format

{
    "769FB3C1-F4C9-4******"    
    "TotalCount": 1, 
    "PageSize": 5, 
    "CurrentPage": 1, 
    "Items": [
        {
            "Status": 1, 
            "TriggerType": 1, 
            "Owner": "***", 
            "TaskId": "mt4HBgtw1B****", 
            "DstPath": "********", 
            "HasUnfinishProcess": false, 
            "DstTypeCode": "OSS", 
            "SrcPath": "*********", 
            "DstType": 2, 
            "GmtCreate": 1583739870000, 
            "TaskName": "Task name", 
            "SrcType": 2, 
            "RunCount": 3, 
            "Id": 1, 
            "SrcTypeCode": "OSS"
        }
    ]
}

Error codes

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