All Products
Search
Document Center

Security Center:DescribeIdcProbeScanResultList

Last Updated:Nov 14, 2024

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

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:DescribeIdcProbeScanResultListget
  • 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.

1
CriteriastringNo

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\"}]
LogicalExpstringNo

The logical operator that combines multiple search conditions. Valid values:

  • OR****
  • AND****
OR
StatusstringNo

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
FoundStartTimelongNo

The start time of the scan.

1720006818000
FoundEndTimelongNo

The end time of the scan.

1720006819000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A3D7C47D-3F11-57BB-90E8-E5C20C61****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

69
Countinteger

The number of entries returned on the current page.

9
Instancesarray<object>

The instances.

Instanceobject

The instance.

ValidPortstring

The port that is scanned.

22
ProbeIntranetIpstring

The private IP address of the associated instance.

192.168.*.*
Osstring

The operating system type of the asset. Valid values:

  • windows
  • linux
Linux
ClientStatusstring

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
ProbeInternetIpstring

The private IP address of the associated instance.

42.121.*.*
LastScanTimelong

The timestamp when the last scan was performed. Unit: milliseconds.

1720006818000
IpSegmentstring

The CIDR blocks.

192.168.2.0/24
ProbeMachineNamestring

The name of the associated instance.

i-xxxx
ScannedIpstring

The IP address that is scanned.

192.168.*.*
ProbeUuidstring

The UUID of the associated instance.

11C96623-E106-59C9-866D-A6C82911****
IdcNamestring

The name of the IDC.

Test
ScanResultIdlong

The ID of the scan result.

1231

Examples

Sample success responses

JSONformat

{
  "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": "Test",
      "ScanResultId": 1231
    }
  ]
}

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.