All Products
Search
Document Center

Data Security Center:DescribeDataMaskingTasks

Last Updated:Nov 17, 2022

Queries de-identification tasks.

Operation Description

Usage notes

You can call this operation to query static de-identification tasks. This facilitates task queries and management.

QPS limit

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The natural language of the request and response. Default value: en_us. Valid values:

  • zh_cn: Chinese
  • en_us: English
zh_cn
SearchKeystringNo

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

test
StartTimelongNo

The beginning of the time range during which the de-identification tasks to be queried are created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1582992000000
EndTimelongNo

The end of the time range during which the de-identification tasks to be queried are created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1583856000000
DstTypeintegerNo

The type of the service to which the de-identified data belongs. Valid values include 1, 2, 3, 4, and 5. A value of 1 indicates MaxCompute. A value of 2 indicates Object Storage Service (OSS). A value of 3 indicates AnalyticDB for MySQL. A value of 4 indicates Tablestore. A value of 5 indicates ApsaraDB RDS.

2
PageSizeintegerNo

The number of entries to return on each page.

10
CurrentPageintegerNo

The number of the page to return.

1

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

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

The number of entries returned on each page.

10
TotalCountinteger

The total number of returned entries.

100
Itemsarray

The list of de-identification tasks.

object

The details of the de-identification task.

Statusinteger

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

  • 0: The de-identification task is disabled.
  • 1: The de-identification task is enabled.
1
Ownerstring

The user who created the de-identification task.

owner
TaskNamestring

The name of the task.

Task name
SrcTypeinteger

The type of the service to which the data to be de-identified belongs. Valid values include 1, 2, 3, 4, and 5. A value of 1 indicates MaxCompute. A value of 2 indicates OSS. A value of 3 indicates AnalyticDB for MySQL. A value of 4 indicates Tablestore. A value of 5 indicates ApsaraDB RDS.

5
DstTypeinteger

The service to which the de-identified data belongs. Valid values include 1, 2, 3, 4, and 5. A value of 1 indicates MaxCompute. A value of 2 indicates OSS. A value of 3 indicates AnalyticDB for MySQL. A value of 4 indicates Tablestore. A value of 5 indicates ApsaraDB RDS.

5
HasUnfinishProcessboolean

Indicates whether the de-identification task is running.

false
OriginalTableboolean

Indicates whether the source table is de-identified.

false
TriggerTypeinteger

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

  • 1: The de-identification task is manually triggered.
  • 2: The de-identification task is run as scheduled.
  • 3: The de-identification task can be manually triggered or run as scheduled.
1
DstTypeCodestring

The service to which the de-identified data belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

RDS
RunCountinteger

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

1
GmtCreatelong

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

1582992000000
TaskIdstring

The ID of the task.

mt4HBgtw1B******
DstPathstring

The destination path.

***/table1
SrcTypeCodestring

The service to which the data to be de-identified belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

RDS
Idlong

The ID of the task.

1
SrcPathstring

The source path.

***/table2

Example

Normal return example

JSONFormat

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 100,
  "Items": [
    {
      "Status": 1,
      "Owner": "owner",
      "TaskName": "Task name",
      "SrcType": 5,
      "DstType": 5,
      "HasUnfinishProcess": true,
      "OriginalTable": true,
      "TriggerType": 1,
      "DstTypeCode": "RDS",
      "RunCount": 1,
      "GmtCreate": 1582992000000,
      "TaskId": "mt4HBgtw1B******",
      "DstPath": "***/table1",
      "SrcTypeCode": "RDS",
      "Id": 1,
      "SrcPath": "***/table2"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.