Call DescribeDataMaskingTasks to retrieve data masking tasks - Data Security Center - Alibaba Cloud - Data Security Center

Queries the list of static data masking tasks.

Operation description

This operation is used to retrieve the list of static data masking tasks for search and task management purposes.

QPS limit

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

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:DescribeDataMaskingTasks

list

*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
SearchKey	string	No	The keyword used to search for tasks. You can search by task name or task ID.	test
StartTime	integer	No	The start time of the task creation period. Format: timestamp. Unit: milliseconds.	1582992000000
EndTime	integer	No	The end time of the task creation period. Format: timestamp. Unit: milliseconds.	1583856000000
DstType	integer	No	The service to which the destination data source belongs. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS. 6: SELF_DB.	2
PageSize	integer	No	The maximum number of entries per page.	10
CurrentPage	integer	No	The page number for a paged query.	1

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 static data masking tasks.
	object	The details of a static data masking task.
Status	integer	The task status. Valid values: 0: Disabled. 1: Enabled.	1
Owner	string	The task creator.	owner
TaskName	string	The task name.	Task name
SrcType	integer	The source service type. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS. 6: SELF_DB.	5
DstType	integer	The service to which the destination data source belongs. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS. 6: SELF_DB.	5
HasUnfinishProcess	boolean	Indicates whether the task is being executed.	false
OriginalTable	boolean	Indicates whether the task masks data in the original table.	false
TriggerType	integer	The execution mode. Valid values: 1: Manual. 2: Scheduled. 3: Manual and scheduled.	1
DstTypeCode	string	The destination service type. Valid values: MaxCompute. OSS. ADS. OTS. RDS. SELF_DB.	RDS
RunCount	integer	The number of executions.	1
GmtCreate	integer	The creation time. Format: timestamp. Unit: milliseconds.	1582992000000
TaskId	string	The task ID.	mt4HBgtw1B******
DstPath	string	The destination path.	***/table1
SrcTypeCode	string	The source service type. Valid values: MaxCompute. OSS. ADS. OTS. RDS. SELF_DB.	RDS
Id	integer	The task ID.	1
SrcPath	string	The source path.	***/table2
SrcMemberAccount	integer	The member accounts to which the source data belongs.	192479427903xxxx
DstMemberAccount	integer	The member accounts to which the destination data belongs.	192479427903xxxx

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 100,
  "Items": [
    {
      "Status": 1,
      "Owner": "owner",
      "TaskName": "Task name",
      "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",
      "SrcMemberAccount": 0,
      "DstMemberAccount": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.