Queries the execution information of a de-identification task.

Operation Description

Usage notes

You can call this operation to query the execution information of a static de-identification task, including the status and progress.

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

Parameter	Type	Required	Description	Example
Lang	string	No	The natural language of the request and response. Default value: en_us. Valid values: zh_cn: Chinese en_us: English	zh_cn
TaskId	string	No	The ID of the de-identification task.	mt4HBgtw1B******
StartTime	long	No	The beginning of the time range to query. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1582992000000
EndTime	long	No	The end of the time range to query. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1583856000000
Status	integer	No	The status of the de-identification task. Valid values: -1: The task waits to be run. 0: The task is being run. 1: The task is run. 2: The task fails to be run. 3: The task is terminated by a user. 4: Part of the data fails to be de-identified.	0
SrcType	integer	No	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 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
DstType	integer	No	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 OSS. A value of 3 indicates AnalyticDB for MySQL. A value of 4 indicates Tablestore. A value of 5 indicates ApsaraDB RDS.	2
PageSize	integer	No	The number of entries to return on each page.	10
CurrentPage	integer	No	The number of the page to return.	1
MainProcessId	long	No	The task ID. NoteIf a task has one or more subtasks, the value of the parameter must be the task ID. Otherwise, leave this parameter empty.	366731
SrcTableName	string	No	The name of the source table.	add

Response parameters

Parameter	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	769FB3C1-F4C9-4******
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of returned entries.	100
Items	array	The execution information of the de-identification task.
	object	The details of the de-identification task.
Status	integer	The status of the de-identification task. Valid values: -1: The task waits to be run. 0: The task is being run. 1: The task is run. 2: The task fails to be run. 3: The task is terminated by a user. 4: Part of the data fails to be de-identified.	1
Type	integer	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.	1
SrcType	integer	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.	2
SrcTableName	string	The name of the source table.	add
MaskingCount	long	The number of rows that are de-identified.	100
Percentage	integer	The progress of the de-identification task.	100
DstType	integer	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 OSS. A value of 3 indicates AnalyticDB for MySQL. A value of 4 indicates Tablestore. A value of 5 indicates ApsaraDB RDS.	2
FailMsg	string	The reason why the de-identification task fails.	error
FailCode	string	The error code returned only when the de-identification task fails.	masking_task_not_found
ConflictCount	long	The number of rows that are in conflict with the data to be de-identified in the destination table to which the data to be de-identified is moved.	0
DstTypeCode	string	The service that stores the de-identified data. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	OSS
EndTime	long	The end time of the de-identification task.	1582251233000
RunIndex	integer	The number of times that the de-identification task is run.	1
StartTime	long	The time when the de-identification task was run. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1582251233000
HasSubProcess	integer	The number of created subtasks.	4
HasDownloadFile	integer	Indicates whether a file is available for download. 1: yes 0: no	1
TaskId	string	The ID of the task.	mt4HBgtw1B******
SrcTypeCode	string	The type of the service to which the data to be de-identified belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	OSS
Id	long	The ID of the task running record.	1

Example

Normal return example

JSONFormat

{
  "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
    }
  ]
}

Error codes

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