GetHoneypotProbe - Security Center - Alibaba Cloud Documentation Center

Queries the details about a specified probe.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:GetHoneypotProbe	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProbeId	string	Yes	The probe ID. Note You can call the ListHoneypotProbe operation to query the IDs of probes.	d6c1ebc9-a90d-4c9e-9490-328814d1ca00
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	object	The information about the probe.
ProbeId	string	The ID of the probe.	40f6501d-45ec-4bf0-b813-0072ceb4****
ProbeType	string	The type of the probe. Valid values: host_probe: host probe vpc_black_hole_probe: virtual private cloud (VPC) probe	host_probe
DisplayName	string	The name of the probe.	test-probe
OsType	string	The operating system of the server on which the probe is deployed. Valid values: windows linux	windows
ProbeVersion	string	The version of the probe.	18060096
HostIp	string	The IP address of the server on which the probe is deployed.	33.53.XX.XX
ControlNode	object	The information about the management node.
NodeId	string	The ID of the management node.	37a15ff1-3475-4897-aa6c-f7fd9122****
NodeName	string	The name of the management node.	online-honeypot
EcsInstanceId	string	The instance ID of the management node.	i-bp19ijepxytwtzrk****
Ping	boolean	Indicates whether ping is enabled for the check type.	false
Arp	boolean	Indicates whether address resolution protocol (ARP) is enabled for the check type.	true
DeployTime	long	The time when the probe was deployed.	1669363825000
Status	integer	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
ListenIpList	array	An array consisting of the IP addresses that can be monitored.
ListenIpList	string	The IP address that can be monitored.	192.168.XX.XX
CpuLoad	double	The CPU utilization.	0.51
MemoryLoad	double	The memory usage.	1.94
HoneypotProbeBindList	array<object>	The honeypots that are bound to the probe.
HoneypotProbeBindList	object	The details about the service to which the probe forwards traffic.
ServiceIpList	array	The IP addresses that are monitored.
ServiceIpList	string	The IP address that is monitored.	192.168.XX.XX
Status	integer	The status of the honeypot that is bound to the probe. Valid values: 1: abnormal 3: normal	3
HoneypotId	string	The honeypot ID.	913347774a3b3c378c6a50f66de23dfa097765214ec3f0526b01c67bf59c****
BindPortList	array<object>	The ports that are bound to the probe.
BindPortList	object	The details about the port that is bound to the probe.
StartPort	integer	The start port on which the probe monitors.	22
EndPort	integer	The end port on which the probe monitors.	80
Proto	string	The type of the protocol.	tcp
Fixed	boolean	Indicates whether the port is a fixed port.	false
TargetPort	integer	The destination port.	80
Id	long	The unique ID of the port binding record.	2512
BindPort	boolean	Indicates whether the port is bound.	false
Err	string	The error that is returned if an error occurred in the port of the honeypot that is bound to the probe.	portmap failed
Msg	string	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
Status	integer	The status of the port of the honeypot that is bound to the probe. Valid values: 1: abnormal 3: normal	3
BindId	string	The unique ID of the honeypot that is bound to the probe.	45378f64-d7b4-4a53-9c48-4303eb4b****
HoneyPotProbeScanPort	object	The ports that the honeypot monitors.
Id	long	The unique ID of the service that is monitored.	15389
ProbeId	string	The ID of the probe.	a46f5162-c70d-4e26-8ddf-7435feca****
ServiceIpList	array	The IP addresses that are monitored.
ServiceIp	string	The IP address that is monitored.	0.0.0.0
Status	integer	The monitoring status. Valid values: 1: abnormal 3: normal	3
Ports	string	The ports that are monitored.	{ "tcp": "1-65535", "udp": "1-65535" }
Uuid	string	The UUID of the asset on which the host probe is deployed.	6690a46c-0edb-4663-a641-3629d1a9****
CanListenIpList	array	An array consisting of the IP addresses that can be monitored.
CanListenIp	string	The IP address that can be monitored.	192.168.XX.XX
CidrList	array	The CIDR blocks of the probe deployed in a virtual private cloud (VPC).
CidrList	string	The CIDR block of the probe deployed in a VPC.	192.168.0.0/16
ProxyIp	string	The IP address of the proxy server.	47.108.XX.XX
VpcId	string	The ID of the VPC in which the probe is deployed.	vpc-2vchkxmf2j9yjt3x2****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	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
Message	string	The message returned.	successful
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	6550E0E6-FD6C-5F39-AB5E-35B30DCA97B5
HttpStatusCode	integer	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 code	Error code	Error message	Description
400	InvalidParam	There was an error with your request.	An error occurred while processing your request. Try again later.
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-25	The Error code has changed	View Change Details
2023-03-01	The Error code has changed. The request parameters of the API has changed	View Change Details