All Products
Search

This Product

    Data Security Center:DescribeDataMaskingRunHistory

    Document Center

    Data Security Center:DescribeDataMaskingRunHistory

    Last Updated:Nov 27, 2025

    You can call DescribeDataMaskingRunHistory to query the execution history of data masking tasks.

    Operation description

    This operation retrieves the execution history of static data masking tasks. You can use it to search for task statuses and view task progress.

    QPS limits

    The queries per second (QPS) limit for a single user on this operation is 10 calls per second. Calls that exceed this limit are throttled. This may affect your business. Plan your calls accordingly.

    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

    *

    		 None 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 to query for task executions. This is a UNIX timestamp in milliseconds.

    1582992000000
    EndTime

    integer

    No

    The end time to query for task executions. This is a UNIX timestamp in milliseconds.

    1583856000000
    Status

    integer

    No

    The execution status of the task. Valid values:

    • -1: pending.

    • 0: running.

    • 1: successful.

    • 2: failed.

    • 3: stopped by user.

    • 4: partially failed.

    0
    SrcType

    integer

    No

    The type of service to which the source data belongs. Valid values: 1 for MaxCompute, 2 for OSS, 3 for ADS, 4 for OTS, and 5 for RDS.

    2
    DstType

    integer

    No

    The type of service to which the masked data is destined. Valid values: 1 for MaxCompute, 2 for OSS, 3 for ADS, 4 for OTS, and 5 for RDS.

    2
    PageSize

    integer

    No

    The number of entries to return on each page.

    10
    CurrentPage

    integer

    No

    The page number to return.

    1
    MainProcessId

    integer

    No

    The ID of the main task.

    Note

    If a task has subtasks, this parameter specifies the ID of the main task. 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 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

    array<object>

    A list of data masking task details.

    object

    The details of the task.

    Status

    integer

    The execution status of the task. Valid values:

    • -1: pending.

    • 0: running.

    • 1: successful.

    • 2: failed.

    • 3: stopped by user.

    • 4: partially failed.

    1
    Type

    integer

    The execution method. Valid values:

    • 1: manual.

    • 2: scheduled.

    1
    SrcType

    integer

    The type of service to which the source data belongs. Valid values: 1 for MaxCompute, 2 for OSS, 3 for ADS, 4 for OTS, and 5 for RDS.

    2
    SrcTableName

    string

    The name of the source table.

    add
    MaskingCount

    integer

    The number of masked rows.

    100
    Percentage

    integer

    The execution progress.

    100
    DstType

    integer

    The type of service to which the masked data is destined. Valid values: 1 for MaxCompute, 2 for OSS, 3 for ADS, 4 for OTS, and 5 for RDS.

    2
    FailMsg

    string

    The reason the task failed.

    error
    FailCode

    string

    The error code returned when the task fails. This parameter has a value only if the task fails.

    masking_task_not_found
    ConflictCount

    integer

    The number of data conflicts. This is the number of rows to be inserted into the destination table that conflict with existing data.

    0
    DstTypeCode

    string

    The type of the destination service. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

    OSS
    EndTime

    integer

    The time when the execution ended. This is a UNIX timestamp in milliseconds.

    1582251233000
    RunIndex

    integer

    The number of times the task has been executed.

    1
    StartTime

    integer

    The time when the execution started. This is a UNIX timestamp in milliseconds.

    1582251233000
    HasSubProcess

    integer

    The number of created subtasks.

    4
    HasDownloadFile

    integer

    Indicates whether a download file is available.

    • 1: Yes.

    • 0: No.

    1
    TaskId

    string

    The ID of the task.

    mt4HBgtw1B******
    SrcTypeCode

    string

    The type of the source service. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

    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.