All Products
Search

This Product

    Security Center:DescribeOnceTask

    Document Center

    Security Center:DescribeOnceTask

    Last Updated:Jun 26, 2026

    Queries a list of client tasks.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskType

    string

    No

    The node type. Valid values:

    • VUL_CHECK_TASK: vulnerability scanning node

    • CLIENT_PROBLEM_CHECK: client node

    • CLIENT_DEV_OPS: cloud O&M node

    • ASSET_SECURITY_CHECK: asset information collection node

    • ASSET_REFRESH_HOST: host asset synchronization node

    Note

    TaskType and RootTaskId cannot both be empty.

    CLIENT_PROBLEM_CHECK
    RootTaskId

    string

    No

    The root task ID.

    Note

    TaskType and RootTaskId cannot both be empty.

    bb5d657479bba5e1d308b6c9e85c9174
    StartTimeQuery

    integer

    No

    The timestamp when the root task starts. Unit: milliseconds.

    1651737301000
    EndTimeQuery

    integer

    No

    The timestamp when the root task ends. Unit: milliseconds.

    1651766520000
    CurrentPage

    integer

    No

    The page number of the page to return. Default value: 1, which indicates the first page.

    1
    PageSize

    integer

    No

    Settings for the number of client tasks on each page in a paged query. Default value: 20, which indicates that each page contains 20 client tasks.

    20
    Source

    string

    No

    The node source. Valid values include but are not limited to:

    • schedule: automatic scheduling of vulnerability scanning

    • console: one-click detection from the vulnerability scanning console

    console
    TaskId

    string

    No

    The task ID.

    d7b2acf8d362742123e4a84e1bf8****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response data of client tasks.

    RequestId

    string

    The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.

    7E0618A9-D5EF-4220-9471-C42B5E92719F
    PageInfo

    object

    The pagination information.

    CurrentPage

    integer

    The page number of the current page in a paged query.

    1
    PageSize

    integer

    The number of client tasks on each page in a paged query. Default value: 20, which indicates that each page contains 20 client tasks.

    20
    TotalCount

    integer

    The total number of client tasks returned.

    100
    Count

    integer

    The number of client tasks displayed on the current page in a paged query.

    2
    TaskManageResponseList

    array<object>

    The list of client task query results.

    object

    The client task query result.

    TaskType

    string

    The task type. Valid values:

    • CLIENT_PROBLEM_CHECK: client task

    • CLIENT_DEV_OPS: cloud O&M task

    • ASSET_SECURITY_CHECK: asset information collection task.

    CLIENT_PROBLEM_CHECK
    Progress

    string

    The task progress, in percentage.

    10%
    TaskStatus

    integer

    The task status. Valid values:

    • 1: Started.

    • 2: Completed.

    • 3: Failed.

    • 4: Timed out.

    1
    DetailData

    string

    The task execution details. This parameter is in JSON format.

    • causeCode: the return code of the troubleshooting cause.

    • causeMsg: the return message of the troubleshooting cause.

    • resCode: the troubleshooting return code.

    • resMsg: the troubleshooting return message.

    • problemType: the problem type.

    • dispatchType: the task dispatch method.

    • uuid: the server UUID.

    • instanceId: the ID of the server instance.

    • internetIp: the public IP address of the server.

    • intranetIp: the private IP address of the server.

    • instanceName: the name of the server instance.

    • url: the download URL of the troubleshooting log.

    [ { "dispatchType": "manual", "causeMsg": [], "causeCode": [], "resCode": [ "1003" ], "resMsg": [ "powershell -executionpolicy bypass -c \"(New-Object Net.WebClient).DownloadFile('http://aegis.alicdn.com/download/aegis_client_self_check/win32/aegis_checker.exe', $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath('.\\\\aegis_checker.exe'))\"; \"./aegis_checker.exe -b eyJtb2RlIjoxLCJqc3J2X2RvbWFpbiI6W10sImlzc3VlIjoib2ZmbGluZSIsInVwZGF0ZV9kb21haW4iOltdLCJ1dWlkIjoiaW5ldC1lYWUwNDg2Ny0wMDJmLTQyM2QtYWYwMC1jNzJjZDYyOWIyNDgiLCJjbWRfaWR4IjoiNDRjZThiZWI3ZGYyYTQxMjQ1NGM4ZDc5OTE1ODI1MzMifQ==\"" ], "problemType": "offline", "uuid": "inet-eae04867-002f-423d-af00-c72cd629****" } ]
    TaskStatusText

    string

    The text representation of the task status. Valid values:

    • INIT: Pending.

    • START: Started.

    • DISPATCH: Self-check command dispatched.

    • SUCCESS: Self-check completed.

    • FAIL: Execution failed.

    • TIMEOUT: Timed out.

    INIT
    TaskName

    string

    The task name.

    CLIENT_PROBLEM_CHECK
    TaskStartTime

    integer

    The timestamp when the task actually starts. Unit: milliseconds.

    1649732012000
    TaskEndTime

    integer

    The timestamp when the task actually ends. Unit: milliseconds.

    1650267989000
    TaskId

    string

    The task ID.

    e900f528f5a6229bb640ca27cb44c98e
    SuccessCount

    integer

    The number of tasks that are executed successfully.

    7
    FailCount

    integer

    The number of tasks that failed to be executed.

    2
    ResultInfo

    string

    The task execution result.

    successful

    Examples

    Success response

    JSON format

    {
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 2
  },
  "TaskManageResponseList": [
    {
      "TaskType": "CLIENT_PROBLEM_CHECK",
      "Progress": "10%",
      "TaskStatus": 1,
      "DetailData": "[\n      {\n            \"dispatchType\": \"manual\",\n            \"causeMsg\": [],\n            \"causeCode\": [],\n            \"resCode\": [\n                  \"1003\"\n            ],\n            \"resMsg\": [\n                  \"powershell -executionpolicy bypass -c \\\"(New-Object Net.WebClient).DownloadFile('http://aegis.alicdn.com/download/aegis_client_self_check/win32/aegis_checker.exe', $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath('.\\\\\\\\aegis_checker.exe'))\\\"; \\\"./aegis_checker.exe -b eyJtb2RlIjoxLCJqc3J2X2RvbWFpbiI6W10sImlzc3VlIjoib2ZmbGluZSIsInVwZGF0ZV9kb21haW4iOltdLCJ1dWlkIjoiaW5ldC1lYWUwNDg2Ny0wMDJmLTQyM2QtYWYwMC1jNzJjZDYyOWIyNDgiLCJjbWRfaWR4IjoiNDRjZThiZWI3ZGYyYTQxMjQ1NGM4ZDc5OTE1ODI1MzMifQ==\\\"\"\n            ],\n            \"problemType\": \"offline\",\n            \"uuid\": \"inet-eae04867-002f-423d-af00-c72cd629****\"\n      }\n]",
      "TaskStatusText": "INIT",
      "TaskName": "CLIENT_PROBLEM_CHECK",
      "TaskStartTime": 1649732012000,
      "TaskEndTime": 1650267989000,
      "TaskId": "e900f528f5a6229bb640ca27cb44c98e",
      "SuccessCount": 7,
      "FailCount": 2,
      "ResultInfo": "successful"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 ServerError ServerError
    403 NoPermission caller has no permission

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.