Use DescribeDataMaskingRunHistory to query data masking task execution history - Data Security Center - Alibaba Cloud - Data Security Center

Queries the execution history of data masking tasks.

Operation description

This operation is used to retrieve the execution status of static data masking tasks, allowing you to search for task statuses and view task progress.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sddp:DescribeDataMaskingRunHistory

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
TaskId	string	No	The ID of the data masking task.	mt4HBgtw1B******
StartTime	integer	No	The start time of the task execution to query. The value is a timestamp in milliseconds.	1582992000000
EndTime	integer	No	The end time of the task execution to query. The value is a timestamp in milliseconds.	1583856000000
Status	integer	No	The task execution status. Valid values: -1: Waiting for execution. 0: Running. 1: Executed successfully. 2: Execution failed. 3: Terminated by user. 4: Partially failed.	0
SrcType	integer	No	The type of the source product to which the data to be masked belongs. Valid values: 1: MaxCompute, 2: OSS, 3: ADS, 4: OTS, 5: RDS, and others.	2
DstType	integer	No	The type of the destination product where the masked data is stored. Valid values: 1: MaxCompute, 2: OSS, 3: ADS, 4: OTS, 5: RDS, and others.	2
PageSize	integer	No	The maximum number of entries per page.	10
CurrentPage	integer	No	The page number for a paged query.	1
MainProcessId	integer	No	The ID of the main task. Note If the task contains subtasks, this parameter is set to the current task ID. Otherwise, this parameter is empty.	366731
SrcTableName	string	No	The name of the source table.	add

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in the results.	1
RequestId	string	The request ID.	769FB3C1-F4C9-4******
PageSize	integer	The number of entries per page in the results.	10
TotalCount	integer	The total number of entries in the results.	100
Items	array<object>	The list of data masking task information.
	object	The details of the query result.
Status	integer	The task execution status. Valid values: -1: Waiting for execution. 0: Running. 1: Executed successfully. 2: Execution failed. 3: Terminated by user. 4: Partially failed.	1
Type	integer	The execution mode. Valid values: 1: Manual. 2: Scheduled.	1
SrcType	integer	The type of the source product to which the data to be masked belongs. Valid values: 1: MaxCompute, 2: OSS, 3: ADS, 4: OTS, 5: RDS, and others.	2
SrcTableName	string	The name of the source table.	add
MaskingCount	integer	The number of rows masked.	100
Percentage	integer	The execution progress.	100
DstType	integer	The type of the destination product where the masked data is stored. Valid values: 1: MaxCompute, 2: OSS, 3: ADS, 4: OTS, 5: RDS, and others.	2
FailMsg	string	The reason for the task execution failure.	error
FailCode	string	The error code for the task execution failure. This parameter has a value only when the task execution fails.	masking_task_not_found
ConflictCount	integer	The number of data conflict rows, which indicates the number of rows where the masked data to be inserted into the destination table conflicts with the existing data in the destination table.	0
DstTypeCode	string	The type of the destination product. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others.	OSS
EndTime	integer	The end time of the execution.	1582251233000
RunIndex	integer	The sequence number of the task execution.	1
StartTime	integer	The execution time. The value is a timestamp in milliseconds.	1582251233000
HasSubProcess	integer	The number of subtasks that have been created.	4
HasDownloadFile	integer	Indicates whether a download file exists. Valid values: 1: Yes. 0: No.	1
TaskId	string	The task ID.	mt4HBgtw1B******
SrcTypeCode	string	The type of the source product. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others.	OSS
Id	integer	The ID of the execution record.	1

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.