All Products
Search

This Product

    Security Center:DescribeProcessTasks

    Document Center

    Security Center:DescribeProcessTasks

    Last Updated:Dec 10, 2025

    Retrieves a list of response tasks.

    Operation description

    Before you call this operation, review the billing methods and pricing for Threat Analysis and Response. Response orchestration is billed based on the volume of ingested log traffic.

    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-sas:DescribeProcessTasks

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProcessStrategyUuid

    string

    No

    The UUID of the response policy.

    Note

    Call the ListDisposeStrategy operation to obtain this parameter.

    92af3c79-1754-4646-9366-9ddbd1e45536_****
    EntityName

    string

    No

    The name of the entity to which the response is performed.

    127.0.0.1
    EntityType

    string

    No

    The type of the entity to which the response is performed. Valid values:

    • ip: an IP address.

    • file: a file.

    • process: a process.

    ip
    SceneCode

    string

    No

    The code of the response scenario.

    Note

    Call the DescribeEnumItems operation to obtain this parameter.

    event_xxx_whole_process
    TaskStatus

    string

    No

    The statuses of the response tasks. The value is a string in an array format. Valid values:

    • 11: The task is in progress.

    • 21: The entity is being blocked.

    • 22: The entity is in isolation.

    • 23: The task is complete.

    • 24: The entity is added to the whitelist.

    • 20: The task is successful.

    • 90: The task failed.

    • 91: Unblocking failed.

    • 92: Removing the entity from isolation failed.

    ["11","21"]
    Scope

    string

    No

    The ID of the Alibaba Cloud account for which the response task is performed.

    125xxxxx9870
    Source

    string

    No

    The source that triggers the response task. The value is a string in an array format. Valid values:

    • system: The task is triggered by manually responding to an event.

    • custom: The task is triggered by an automatic response rule for an event.

    • custom_alert: The task is triggered by an automatic response rule for an alert.

    • soar-manual: The task is triggered by a playbook that is manually run in Security Orchestration Automation Response (SOAR).

    • soar-mdr: The task is triggered by Managed Security Service.

    ["system"]
    ProcessActionStart

    integer

    No

    The start of the time range to query response tasks. The value is a 13-digit UNIX timestamp.

    1700031183572
    ProcessActionEnd

    integer

    No

    The end of the time range to query response tasks. The value is a 13-digit UNIX timestamp.

    1700031183572
    ProcessRemoveStart

    integer

    No

    The start of the time range to query unblocking tasks. The value is a 13-digit UNIX timestamp.

    1700031183572
    ProcessRemoveEnd

    integer

    No

    The end of the time range to query unblocking tasks. The value is a 13-digit UNIX timestamp.

    1700031183572
    ParamContent

    string

    No

    The keyword for a fuzzy search. The operation queries the entity, response scenario, and response parameter fields.

    12.x.x.x
    PageSize

    integer

    No

    The number of entries to return on each page. Default value: 20. If you do not specify this parameter, 10 entries are returned.

    Note

    Specify this parameter.

    10
    PageNumber

    integer

    No

    The page number to return. Default value: 1. This value indicates the first page.

    1
    YunCode

    string

    No

    The cloud service associated with the response task. The value is a string in an array format. Valid values:

    • WAF: Web Application Firewall

    • CFW: Cloud Firewall

    • Aegis: Security Center

    ["WAF"]
    TaskId

    string

    No

    The unique ID of the response task.

    Note

    Use this parameter to query a specific task. You can obtain the task ID from the response to a previous request.

    150xxxxxxxxx95066
    OrderField

    string

    No

    The field by which to sort the query results.

    Note

    You can obtain the field from the response.

    gmtCreate
    Direction

    string

    No

    The sort order. Valid values:

    • desc: descending (default)

    • asc: ascending

    desc
    EntityUuid

    string

    No

    The UUID of the entity.

    69d189e2-ec17-4676-a2fe-02969234****

    EventUuid

    string

    No

    The UUID of the event.

    c1020ce1-d6a5-11e8-8298-00163e10****
    TriggerSource

    string

    No

    The source that triggers the response task. Valid values:

    • system: The task is triggered by manually responding to an event.

    • custom: The task is triggered by an automatic response rule for an event.

    • custom_alert: The task is triggered by an automatic response rule for an alert.

    • soar-manual: The task is triggered by a playbook that is manually run in SOAR.

    • soar-mdr: The task is triggered by Managed Security Service.

    system
    ReqUuid

    string

    No

    The playbook trigger ID.

    b73d0b08-f1bd-4e8f-967a-8e2982c9****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The ID of the request. You can use this ID to troubleshoot issues.

    E7698CFB-4E1C-5840-8EC9-691B86729E94
    ProcessTasks

    array<object>

    A list of response tasks.

    object

    The details of the response task.

    TaskId

    string

    The unique ID of the response task.

    150xxxxxxxxx95066
    Creator

    string

    The ID of the Alibaba Cloud account that submitted the response task.

    123xxxx355
    GmtCreateMillis

    integer

    The time when the response task was created. This value is a 13-digit UNIX timestamp.

    1700031183572
    GmtModifiedMillis

    integer

    The time when the response task was last modified. This value is a 13-digit UNIX timestamp.

    1700031183572
    YunCode

    string

    The code of the cloud service that is associated with the response task.

    WAF
    EntityName

    string

    The name of the entity to which the response was performed.

    1.1.1.x
    EntityType

    string

    The type of the entity to which the response was performed.

    ip
    TaskStatus

    integer

    The status of the response task.

    11
    Scope

    string

    The ID of the Alibaba Cloud account for which the response task was performed.

    123xxxxx234
    InputParams

    string

    The input parameters of the response task.

    {"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}
    SceneCode

    string

    The code of the response scenario.

    event_xxx_whole_process
    SceneName

    string

    The name of the response scenario.

    waf_whole_process
    ProcessTime

    integer

    The time when the response task was delivered. This value is a 13-digit UNIX timestamp.

    1700031183572
    RemoveTime

    integer

    The time when the entity was unblocked. This value is a 13-digit UNIX timestamp.

    1700031183572
    ProcessStrategyUuid

    string

    The ID of the associated policy.

    92af3c79-1754-4646-9366-9ddbd1e45536_****
    Source

    string

    The source from which the response task was submitted.

    system
    ErrCode

    string

    The error code.

    sts_openapi.Info.DefenseSceneNotSupported
    ErrMsg

    string

    The error message.

    ParamError : The parameters of your request are invalid
    ErrTip

    string

    The error message details.

    Verify that the input parameters of the components are correct
    EntityUuid

    string

    The UUID of the entity.

    69d189e2-ec17-4676-a2fe-02969234****

    EventUuid

    string

    The UUID of the event.

    c1020ce1-d6a5-11e8-8298-00163e10****

    ReqUuid

    string

    The UUID of the playbook execution record.

    93e5df20-3d03-42e1-b44b-58197c71****

    TriggerSource

    string

    The source that triggers the response task. Valid values:

    • system: The task is triggered by manually responding to an event.

    • custom: The task is triggered by an automatic response rule for an event.

    • custom_alert: The task is triggered by an automatic response rule for an alert.

    • soar-manual: The task is triggered by a playbook that is manually run in SOAR.

    • soar-mdr: The task is triggered by Managed Security Service.

    system
    Page

    object

    The pagination information.

    TotalCount

    integer

    The total number of entries returned.

    30
    PageNumber

    integer

    The page number of the returned page.

    1
    PageSize

    integer

    The number of entries per page.

    10

    Examples

    Success response

    JSON format

    {
  "RequestId": "E7698CFB-4E1C-5840-8EC9-691B86729E94",
  "ProcessTasks": [
    {
      "TaskId": "150xxxxxxxxx95066",
      "Creator": "123xxxx355",
      "GmtCreateMillis": 1700031183572,
      "GmtModifiedMillis": 1700031183572,
      "YunCode": "WAF",
      "EntityName": "1.1.1.x",
      "EntityType": "ip",
      "TaskStatus": 11,
      "Scope": "123xxxxx234",
      "InputParams": "{\"groupuuid\":\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\"}",
      "SceneCode": "event_xxx_whole_process",
      "SceneName": "waf_whole_process",
      "ProcessTime": 1700031183572,
      "RemoveTime": 1700031183572,
      "ProcessStrategyUuid": "92af3c79-1754-4646-9366-9ddbd1e45536_****",
      "Source": "system",
      "ErrCode": "sts_openapi.Info.DefenseSceneNotSupported",
      "ErrMsg": "ParamError : The parameters of your request are invalid",
      "ErrTip": "Verify that the input parameters of the components are correct",
      "EntityUuid": "69d189e2-ec17-4676-a2fe-02969234****\n",
      "EventUuid": "c1020ce1-d6a5-11e8-8298-00163e10****\n",
      "ReqUuid": "93e5df20-3d03-42e1-b44b-58197c71****\n",
      "TriggerSource": "system"
    }
  ],
  "Page": {
    "TotalCount": 30,
    "PageNumber": 1,
    "PageSize": 10
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.