All Products
Search

This Product

    Data Security Center:DescribeDataMaskingTasks

    Document Center

    Data Security Center:DescribeDataMaskingTasks

    Last Updated:Nov 27, 2025

    Call DescribeDataMaskingTasks to retrieve a list of data masking tasks.

    Operation description

    This operation retrieves a list of static data masking tasks, which you can then search and manage.

    QPS limits

    The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, your API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

    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

    *

    		 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
    SearchKey

    string

    No

    A keyword to search for tasks. You can search by task name or task ID.

    test
    StartTime

    integer

    No

    The start time for creating the task. The value is a UNIX timestamp. Unit: milliseconds.

    1582992000000
    EndTime

    integer

    No

    The end time for creating the data masking task. The value is a UNIX timestamp. Unit: milliseconds.

    1583856000000
    DstType

    integer

    No

    The product that the destination data source belongs to. Valid values:

    • 1: MaxCompute.

    • 2: OSS.

    • 3: ADS.

    • 4: OTS.

    • 5: RDS.

    • 6: SELF_DB.

    2
    PageSize

    integer

    No

    The number of entries to return on each page.

    10
    CurrentPage

    integer

    No

    The page number to return.

    1

    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 tasks.

    object

    The details of the data masking task.

    Status

    integer

    The status of the task. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    1
    Owner

    string

    The creator of the task.

    owner
    TaskName

    string

    The name of the task.

    任务名称
    SrcType

    integer

    The type of the source product. Valid values:

    • 1: MaxCompute.

    • 2: OSS.

    • 3: ADS.

    • 4: OTS.

    • 5: RDS.

    • 6: SELF_DB.

    5
    DstType

    integer

    The product that the destination data source belongs to. Valid values:

    • 1: MaxCompute.

    • 2: OSS.

    • 3: ADS.

    • 4: OTS.

    • 5: RDS.

    • 6: SELF_DB.

    5
    HasUnfinishProcess

    boolean

    Indicates whether the task is running.

    false
    OriginalTable

    boolean

    Indicates whether the source table is masked.

    false
    TriggerType

    integer

    The execution method of the task. Valid values:

    • 1: Manual.

    • 2: Scheduled.

    • 3: Manual and scheduled.

    1
    DstTypeCode

    string

    The type of the destination product. Valid values:

    • MaxCompute.

    • OSS.

    • ADS.

    • OTS.

    • RDS.

    • SELF_DB.

    RDS
    RunCount

    integer

    The number of executions.

    1
    GmtCreate

    integer

    The time when the task was created. The value is a UNIX timestamp. Unit: milliseconds.

    1582992000000
    TaskId

    string

    The string ID of the task.

    mt4HBgtw1B******
    DstPath

    string

    The destination path.

    ***/table1
    SrcTypeCode

    string

    The type of the source product. Valid values:

    • MaxCompute.

    • OSS.

    • ADS.

    • OTS.

    • RDS.

    • SELF_DB.

    RDS
    Id

    integer

    The numerical ID of the task.

    1
    SrcPath

    string

    The source path.

    ***/table2
    SrcMemberAccount

    integer

    The member account that the data masking source belongs to.

    192479427903xxxx
    DstMemberAccount

    integer

    The member account that the data masking destination belongs to.

    192479427903xxxx

    Examples

    Success response

    JSON format

    {
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 100,
  "Items": [
    {
      "Status": 1,
      "Owner": "owner",
      "TaskName": "任务名称",
      "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.