Queries de-identification tasks.

Operation description

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

Limits

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese en_us: English	zh_cn
SearchKey	string	No	The keyword used to query the de-identification tasks, which can be the task name or ID.	test
StartTime	long	No	The beginning of the time range during which the de-identification tasks to be queried are created. The value is a UNIX timestamp. Unit: milliseconds.	1582992000000
EndTime	long	No	The end of the time range during which the de-identification tasks to be queried are created. The value is a UNIX timestamp. Unit: milliseconds.	1583856000000
DstType	integer	No	The service to which the data to be de-identified belongs. Valid values include 1, 2, 3, 4, and 5. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.	2
PageSize	integer	No	The number of entries to return on each page.	10
CurrentPage	integer	No	The page number of the page to return.	1

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 per page.	10
TotalCount	integer	The total number of entries returned.	100
Items	object []	An array that consists of de-identification tasks.
Status	integer	The status of the task. Valid values: 0: disabled 1: enabled	1
Owner	string	The user who created the de-identification task.	owner
TaskName	string	The name of the task.	Task name
SrcType	integer	The code of the service to which the data to be de-identified belongs. Valid values: 1, 2, 3, 4, and 5. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.	5
DstType	integer	The service to which the data to be de-identified belongs. Valid values: 1, 2, 3, 4, and 5. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.	5
HasUnfinishProcess	boolean	Indicates whether the de-identification task is running.	false
OriginalTable	boolean	Indicates whether the source table is de-identified.	false
TriggerType	integer	The mode in which the de-identification task is run. Valid values: 1: manual 2: scheduled 3: manual and scheduled	1
DstTypeCode	string	The service to which the de-identified data belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	RDS
RunCount	integer	The number of times that the de-identification task is run.	1
GmtCreate	long	The time when the task was created. The value is a UNIX timestamp. Unit: milliseconds.	1582992000000
TaskId	string	The ID of the task.	mt4HBgtw1B******
DstPath	string	The destination directory.	***/table1
SrcTypeCode	string	The service to which the data to be de-identified belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	RDS
Id	long	The ID of the task.	1
SrcPath	string	The source path.	***/table2

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 100,
  "Items": [
    {
      "Status": 1,
      "Owner": "owner",
      "TaskName": "Task name\n",
      "SrcType": 5,
      "DstType": 5,
      "HasUnfinishProcess": false,
      "OriginalTable": false,
      "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 Service error codes.

Change history

Change time	Summary of changes	Operation

No change history