DescribeIdcProbeScanResultList API Reference - Security Center

Queries assets that are identified by Internet Data Center (IDC) probes.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	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
CurrentPage	integer	No	The page number.	1
Criteria	string	No	The search conditions for assets. This parameter is in the JSON format. The value is case-sensitive. Note A search condition can be the instance ID, instance name, VPC ID, region, or public IP address. You can call the DescribeIdcAssetCriteria operation to query supported search conditions.	[{\"name\":\"scannedIp\",\"value\":\"192.168.2.11\"}]
LogicalExp	string	No	The logical operator that combines multiple search conditions. Valid values: OR** AND******	OR
Status	string	No	The statuses of the corresponding probes. Separate multiple values with commas (,). Valid values: 0: The probe is valid. 1: The probe is ignored. 2: The probe is invalid. 3: The probe expired. 4: The probe does not exist.	0,1
FoundStartTime	integer	No	The start time of the scan.	1720006818000
FoundEndTime	integer	No	The end time of the scan.	1720006819000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A3D7C47D-3F11-57BB-90E8-E5C20C61****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	69
Count	integer	The number of entries returned on the current page.	9
Instances	array<object>	The instances.
	object	The instance.
ValidPort	string	The port that is scanned.	22
ProbeIntranetIp	string	The private IP address of the associated instance.	192.168..
Os	string	The operating system type of the asset. Valid values: windows linux	Linux
ClientStatus	string	The status of the client of the instance on which the probe is installed. Valid values: online: The Security Center agent on the asset is enabled. offline: The Security Center agent on the asset is disabled.	online
ProbeInternetIp	string	The private IP address of the associated instance.	42.121..
LastScanTime	integer	The timestamp when the last scan was performed. Unit: milliseconds.	1720006818000
IpSegment	string	The CIDR blocks.	192.168.2.0/24
ProbeMachineName	string	The name of the associated instance.	i-xxxx
ScannedIp	string	The IP address that is scanned.	192.168..
ProbeUuid	string	The UUID of the associated instance.	11C96623-E106-59C9-866D-A6C82911****
IdcName	string	The name of the IDC.	3K IDC Guangzhou
ScanResultId	integer	The ID of the scan result.	1231

Examples

Success response

JSON format

{
  "RequestId": "A3D7C47D-3F11-57BB-90E8-E5C20C61****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 9
  },
  "Instances": [
    {
      "ValidPort": "22",
      "ProbeIntranetIp": "192.168.*.*",
      "Os": "Linux",
      "ClientStatus": "online",
      "ProbeInternetIp": "42.121.*.*",
      "LastScanTime": 1720006818000,
      "IpSegment": "192.168.2.0/24",
      "ProbeMachineName": "i-xxxx",
      "ScannedIp": "192.168.*.*",
      "ProbeUuid": "11C96623-E106-59C9-866D-A6C82911****\n",
      "IdcName": "3K IDC Guangzhou",
      "ScanResultId": 1231
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.