All Products
Search
Document Center

Security Center:ListAgentlessTask

Last Updated:Mar 14, 2024

Queries agentless detection tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListAgentlessTaskRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

20
TargetTypeintegerNo

The type of the asset that you want to detect. Valid values:

  • 1: snapshot
  • 2: image
1
RootTaskIdstringNo

The ID of the main task.

12c27343861610c5db3f7a2573b4****
StatusintegerNo

The status of the detection task.

  • 1: The detection task is in progress.
  • 2: The detection task is complete.
  • 3: The detection task fails.
  • 4: The detection task times out.
2
StartTimelongNo

The start timestamp of the task.

1651290987000
EndTimelongNo

The end timestamp of the task.

1635575219000
RootTaskbooleanNo

Specifies whether to query main tasks. Valid values:

  • true: queries main tasks.
  • false: queries subtasks.
false
TaskIdstringNo

The ID of the main task. If you want to query subtasks of a main task, you must specify this parameter.

d7b2acf8d362742123e4a84e1bf8****
MachineNamestringNo

The name of the instance.

oracle-win-001****
InternetIpstringNo

The public IP address of the asset that you want to query.

1.1.XX.XX
IntranetIpstringNo

The private IP address of the asset that you want to query.

172.26.XX.XX
UuidstringNo

The UUID of the server.

e4af3620-6895-4e2f-a641-a9d8fb53****
TargetNamestringNo

The name of the asset that you want to detect.

source-test-obj-0****
LangstringNo

The language type. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1A975D03-5F49-5354-B2CB-3918D5DA****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

55
Listobject []

The tasks.

TaskIdstring

The ID of the task.

1538****
TaskNamestring

The name of the detection task.

AGENTLESS_SCAN
TargetTypeinteger

The type of the asset that is detected. Valid values:

  • 1: snapshot
  • 2: image
2
Statusinteger

The status of the detection task.

  • 1: The detection task is in progress.
  • 2: The detection task is complete.
  • 3: The detection task fails.
  • 4: The detection task times out.
1
Progressinteger

The progress of the task.

60
StartTimelong

The start timestamp of the task. Unit: milliseconds.

1672741657897
EndTimelong

The end timestamp of the task. Unit: milliseconds.

1678895999999
Resultstring

The result of the detection.

True
Uuidstring

The UUID of the asset.

49e25e0f-bb51-4a5a-a1b3-13a4ddaa****
InternetIpstring

The public IP address of the server.

8.210.XX.XX
IntranetIpstring

The private IP address of the server.

172.25.XX.XX
InstanceNamestring

The name of the asset.

sql-test-0****
TargetNamestring

The name of the asset that is detected.

hkdevt****
ProgressByProjectstring

The execution progress of the inspection items.

"{\"scaVul\":100,\"binary\":100,\"baseline\":100,\"vul\":100,\"webshell\":100,\"script\":100,\"sensitiveInfo\":100}"
ReportStatusstring

The status of the report. Possible values:

  • PREPARED: In preparation.
  • RUNNING: In progress.
  • SUCCESS: Successful.
  • TIMEOUT: Timeout.
  • FAILED: Failed.
SUCCESS
ReportDownloadUrlstring

The download link for the report.

http://newsas-oss-bucket.oss-cn-hangzhou.aliyuncs.com/agent_less_single_report****
MeasureSpacelong

The volume of detection data, in MB.

154.11

Examples

Sample success responses

JSONformat

{
  "RequestId": "1A975D03-5F49-5354-B2CB-3918D5DA****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 55
  },
  "List": [
    {
      "TaskId": "1538****",
      "TaskName": "AGENTLESS_SCAN",
      "TargetType": 2,
      "Status": 1,
      "Progress": 60,
      "StartTime": 1672741657897,
      "EndTime": 1678895999999,
      "Result": "True",
      "Uuid": "49e25e0f-bb51-4a5a-a1b3-13a4ddaa****",
      "InternetIp": "8.210.XX.XX",
      "IntranetIp": "172.25.XX.XX",
      "InstanceName": "sql-test-0****",
      "TargetName": "hkdevt****",
      "ProgressByProject": "\"{\\\"scaVul\\\":100,\\\"binary\\\":100,\\\"baseline\\\":100,\\\"vul\\\":100,\\\"webshell\\\":100,\\\"script\\\":100,\\\"sensitiveInfo\\\":100}\"",
      "ReportStatus": "SUCCESS",
      "ReportDownloadUrl": "http://newsas-oss-bucket.oss-cn-hangzhou.aliyuncs.com/agent_less_single_report****",
      "MeasureSpace": 154.11
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-31The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.