All Products
Search
Document Center

Security Center:GetHoneypotProbe

Last Updated:Feb 20, 2024

Queries the details about a specified probe.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ProbeIdstringYes

The probe ID.

Note You can call the ListHoneypotProbe operation to query the IDs of probes.
d6c1ebc9-a90d-4c9e-9490-328814d1ca00
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The information about the probe.

ProbeIdstring

The ID of the probe.

40f6501d-45ec-4bf0-b813-0072ceb4****
ProbeTypestring

The type of the probe. Valid values:

  • host_probe: host probe
  • vpc_black_hole_probe: virtual private cloud (VPC) probe
host_probe
DisplayNamestring

The name of the probe.

test-probe
OsTypestring

The operating system of the server on which the probe is deployed. Valid values:

  • windows
  • linux
windows
ProbeVersionstring

The version of the probe.

18060096
HostIpstring

The IP address of the server on which the probe is deployed.

33.53.XX.XX
ControlNodeobject

The information about the management node.

NodeIdstring

The ID of the management node.

37a15ff1-3475-4897-aa6c-f7fd9122****
NodeNamestring

The name of the management node.

online-honeypot
EcsInstanceIdstring

The instance ID of the management node.

i-bp19ijepxytwtzrk****
Pingboolean

Indicates whether ping is enabled for the check type.

false
Arpboolean

Indicates whether address resolution protocol (ARP) is enabled for the check type.

true
DeployTimelong

The time when the probe was deployed.

1669363825000
Statusinteger

The status of the probe. Valid values:

  • installed: installed
  • install_failed: installation failed
  • online: online
  • offline: offline
  • unnormal: abnormal
  • unprobe: unauthorized
  • uninstalling: being uninstalled
  • uninstalled: uninstalled
  • uninstall_failed: uninstallation failed
  • not_exist: not installed
online
ListenIpListarray

An array consisting of the IP addresses that can be monitored.

string

The IP address that can be monitored.

192.168.XX.XX
CpuLoaddouble

The CPU utilization.

0.51
MemoryLoaddouble

The memory usage.

1.94
HoneypotProbeBindListobject []

The honeypots that are bound to the probe.

ServiceIpListarray

The IP addresses that are monitored.

string

The IP address that is monitored.

192.168.XX.XX
Statusinteger

The status of the honeypot that is bound to the probe. Valid values:

  • 1: abnormal
  • 3: normal
3
HoneypotIdstring

The honeypot ID.

913347774a3b3c378c6a50f66de23dfa097765214ec3f0526b01c67bf59c****
BindPortListobject []

The ports that are bound to the probe.

StartPortinteger

The start port on which the probe monitors.

22
EndPortinteger

The end port on which the probe monitors.

80
Protostring

The type of the protocol.

tcp
Fixedboolean

Indicates whether the port is a fixed port.

false
TargetPortinteger

The destination port.

80
Idlong

The unique ID of the port binding record.

2512
BindPortboolean

Indicates whether the port is bound.

false
Errstring

The error that is returned if an error occurred in the port of the honeypot that is bound to the probe.

portmap failed
Msgstring

The error message that is returned if an error occurred in the port of the honeypot that is bound to the probe.

listen 22 tcp4 failed
Statusinteger

The status of the port of the honeypot that is bound to the probe. Valid values:

  • 1: abnormal
  • 3: normal
3
BindIdstring

The unique ID of the honeypot that is bound to the probe.

45378f64-d7b4-4a53-9c48-4303eb4b****
HoneyPotProbeScanPortobject

The ports that the honeypot monitors.

Idlong

The unique ID of the service that is monitored.

15389
ProbeIdstring

The ID of the probe.

a46f5162-c70d-4e26-8ddf-7435feca****
ServiceIpListarray

The IP addresses that are monitored.

string

The IP address that is monitored.

0.0.0.0
Statusinteger

The monitoring status. Valid values:

  • 1: abnormal
  • 3: normal
3
Portsstring

The ports that are monitored.

{ "tcp": "1-65535", "udp": "1-65535" }
Uuidstring

The UUID of the asset on which the host probe is deployed.

6690a46c-0edb-4663-a641-3629d1a9****
CanListenIpListarray

An array consisting of the IP addresses that can be monitored.

string

The IP address that can be monitored.

192.168.XX.XX
CidrListarray

The CIDR blocks of the probe deployed in a virtual private cloud (VPC).

string

The CIDR block of the probe deployed in a VPC.

192.168.0.0/16
ProxyIpstring

The IP address of the proxy server.

47.108.XX.XX
VpcIdstring

The ID of the VPC in which the probe is deployed.

vpc-2vchkxmf2j9yjt3x2****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codestring

The status code returned. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.

200
Messagestring

The message returned.

successful
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

6550E0E6-FD6C-5F39-AB5E-35B30DCA97B5
HttpStatusCodeinteger

The HTTP status code returned.

200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "ProbeId": "40f6501d-45ec-4bf0-b813-0072ceb4****",
    "ProbeType": "host_probe",
    "DisplayName": "test-probe",
    "OsType": "windows",
    "ProbeVersion": "18060096",
    "HostIp": "33.53.XX.XX",
    "ControlNode": {
      "NodeId": "37a15ff1-3475-4897-aa6c-f7fd9122****",
      "NodeName": "online-honeypot",
      "EcsInstanceId": "i-bp19ijepxytwtzrk****"
    },
    "Ping": false,
    "Arp": true,
    "DeployTime": 1669363825000,
    "Status": 0,
    "ListenIpList": [
      "192.168.XX.XX"
    ],
    "CpuLoad": 0.51,
    "MemoryLoad": 1.94,
    "HoneypotProbeBindList": [
      {
        "ServiceIpList": [
          "192.168.XX.XX"
        ],
        "Status": 3,
        "HoneypotId": "913347774a3b3c378c6a50f66de23dfa097765214ec3f0526b01c67bf59c****",
        "BindPortList": [
          {
            "StartPort": 22,
            "EndPort": 80,
            "Proto": "tcp",
            "Fixed": false,
            "TargetPort": 80,
            "Id": 2512,
            "BindPort": false,
            "Err": "portmap failed",
            "Msg": "listen 22 tcp4 failed",
            "Status": 3
          }
        ],
        "BindId": "45378f64-d7b4-4a53-9c48-4303eb4b****"
      }
    ],
    "HoneyPotProbeScanPort": {
      "Id": 15389,
      "ProbeId": "a46f5162-c70d-4e26-8ddf-7435feca****",
      "ServiceIpList": [
        "0.0.0.0"
      ],
      "Status": 3,
      "Ports": "{\n    \"tcp\": \"1-65535\",\n    \"udp\": \"1-65535\"\n}"
    },
    "Uuid": "6690a46c-0edb-4663-a641-3629d1a9****",
    "CanListenIpList": [
      "192.168.XX.XX"
    ],
    "CidrList": [
      "192.168.0.0/16"
    ],
    "ProxyIp": "47.108.XX.XX",
    "VpcId": "vpc-2vchkxmf2j9yjt3x2****"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "6550E0E6-FD6C-5F39-AB5E-35B30DCA97B5",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamThere was an error with your request.An error occurred while processing your request. Try again later.
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
2023-03-01The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Lang