DescribeSyncAssetTaskList API Reference for IDC Asset Sync - Security Center - Alibaba Cloud - Security Center

Queries the list of asset synchronization IDC scan 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:DescribeSyncAssetTaskList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The maximum number of entries per page in a paged query. Default value: 20. If the PageSize parameter is left empty, 20 entries are returned by default. Note Do not leave PageSize empty.	20
CurrentPage	integer	No	The page number of the page to return. Default value: 1, which indicates that the first page is returned.	1
TaskName	string	No	The task name.	IDC_PROBE_SCAN***
StartTime	integer	No	The start timestamp of the IDC scan task to query. Unit: milliseconds.	1652063828796
EndTime	integer	No	The end timestamp of the IDC scan task to query. Unit: milliseconds.	1662430077000

Response elements

Element	Type	Description	Example
	object
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.	24A20733-10A0-4AF6-BE6B-E3322413BB68
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in a paged query.	1
PageSize	integer	The number of IDC scan tasks displayed per page in a paged query. Default value: 20.	20
TotalCount	integer	The total number of IDC scan tasks returned.	110
Count	integer	The number of IDC scan tasks displayed on the current page.	10
TaskRecords	array<object>	The list of IDC scan tasks.
	object	The IDC scan task.
TaskType	string	The task type. The value is fixed as IDC_PROBE_SCAN, which indicates an IDC scan task.	IDC_PROBE_SCAN
TaskStatus	string	The status of the IDC probe scan task. Valid values: INIT: pending startup START: started MESSAGE_SEND: instruction sent SUCCESS: completed FAIL: failed TIMEOUT: timed out.	SUCCESS
TaskName	string	The task name.	IDC_PROBE_SCAN-1.1.1..124-lse_ubuntu_test1
RootTaskId	string	The root task ID.	73c392f9c505129a257472a3f911d65d
ProcessRate	integer	The progress percentage.	100
TaskStartTime	integer	The timestamp when the task actually started. Unit: milliseconds.	1633746651715
AssetCount	integer	The number of assets discovered by this scan task.	100
TaskEndTime	integer	The timestamp when the task actually ended.	1653965680000
IpSegments	string	The CIDR blocks to scan. Multiple values are separated by commas (,).	1.1.1.1/24,1.1.1.1/24

Examples

Success response

JSON format

{
  "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 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.