All Products
Search
Document Center

Security Center:DescribeSyncAssetTaskList

Last Updated:Nov 25, 2024

Queries a list of IDC scan tasks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeSyncAssetTaskListlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

The page number. Default value: 1. Pages start from page 1.

1
TaskNamestringNo

The name of the IDC scan task.

IDC_PROBE_SCAN***
StartTimelongNo

The timestamp when the IDC scan task starts. Unit: milliseconds.

1652063828796
EndTimelongNo

The timestamp when the IDC scan task ends. Unit: milliseconds.

1662430077000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

24A20733-10A0-4AF6-BE6B-E3322413BB68
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of IDC scan tasks per page. Default value: 20. If you leave this parameter empty, 20 IDC scan tasks are returned on each page.

20
TotalCountinteger

The total number of IDC scan tasks returned.

110
Countinteger

The number of IDC scan tasks on the current page.

10
TaskRecordsarray<object>

The IDC scan tasks.

TaskRecordobject

The IDC scan task.

TaskTypestring

The type of the task. The value is fixed as IDC_PROBE_SCAN, which indicates an IDC scan task.

IDC_PROBE_SCAN
TaskStatusstring

The status of the IDC scan task. Valid Values:

  • INIT: The task is not started.
  • START: The task is started.
  • MESSAGE_SEND: The command is sent.
  • SUCCESS: The task is complete.
  • FAIL: The task failed.
  • TIMEOUT: The task timed out.
SUCCESS
TaskNamestring

The name of the task.

IDC_PROBE_SCAN-1.1.1..124-lse_ubuntu_test1
RootTaskIdstring

The ID of the root task.

73c392f9c505129a257472a3f911d65d
ProcessRateinteger

The progress of the task, in percentage.

100
TaskStartTimelong

The timestamp when the task started. Unit: milliseconds.

1633746651715
AssetCountinteger

The number of assets that are detected by the task.

100
TaskEndTimelong

The timestamp when the task ended.

1653965680000
IpSegmentsstring

The CIDR blocks that are used for scanning. Multiple CIDR blocks are separated by commas (,).

1.1.1.1/24,1.1.1.1/24

Examples

Sample success responses

JSONformat

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 110,
    "Count": 10
  },
  "TaskRecords": [
    {
      "TaskType": "IDC_PROBE_SCAN",
      "TaskStatus": "SUCCESS",
      "TaskName": "IDC_PROBE_SCAN-1.1.1..124-lse_ubuntu_test1",
      "RootTaskId": "73c392f9c505129a257472a3f911d65d",
      "ProcessRate": 100,
      "TaskStartTime": 1633746651715,
      "AssetCount": 100,
      "TaskEndTime": 1653965680000,
      "IpSegments": "1.1.1.1/24,1.1.1.1/24"
    }
  ]
}

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.