ListHoneypotProbe - Security Center - Alibaba Cloud Documentation Center

Queries 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.

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:ListHoneypotProbe	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProbeStatus	string	No	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
DisplayName	string	No	The name of the probe.	probe-test
ProbeType	string	No	The type of the probe. Valid values: host_probe: host probe vpc_black_hole_probe: VPC probe	host_probe
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	en
CurrentPage	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each 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

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
List	array<object>	An array that consists of the details about the probe.
List	object	The information about the probe.
ProbeId	string	The ID of the probe.	4d167bb3-dd09-4a6a-a179-d5d6a5b0****
ProbeType	string	The type of the probe. Valid values: host_probe: host probe vpc_black_hole_probe: VPC probe	host_probe
ProbeVersion	string	The version of the probe.	18060096
DisplayName	string	The name of the probe.	prod-pinpoint-hd1b
OsType	string	The operating system of the server on which the probe is deployed. Valid values: windows linux	windows
HostIp	string	The IP address of the server on which the probe is installed.	33.53.XX.XX
ControlNode	object	The information about the management node.
NodeId	string	The ID of the node.	8ec9da17-c0e7-4642-aad6-defc9722****
NodeName	string	The name of the node.	HoneypotNode1
EcsInstanceId	string	The ID of the Elastic Compute Service (ECS) instance.	i-uf6eq0rlvu1mkh0p****
DeployTime	long	The time when the probe was deployed.	1669363825000
Status	string	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
Uuid	string	The UUID of the server to which the host probe is deployed.	49e25e0f-bb51-4a5a-a1b3-13a4ddaa****
VpcId	string	The ID of the VPC in which the VPC probe is deployed.	vpc-5gu8iu68w9b472jbb****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 20.	20
TotalCount	integer	The total number of entries returned.	30
Count	integer	The number of entries returned on the current page.	20
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 that is 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.	4BC9E610-21BE-537F-82EF-144A60D5A970
HttpStatusCode	integer	The HTTP status code that is returned.	200

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "ProbeId": "4d167bb3-dd09-4a6a-a179-d5d6a5b0****",
      "ProbeType": "host_probe",
      "ProbeVersion": "18060096",
      "DisplayName": "prod-pinpoint-hd1b ",
      "OsType": "windows",
      "HostIp": "33.53.XX.XX",
      "ControlNode": {
        "NodeId": "8ec9da17-c0e7-4642-aad6-defc9722****",
        "NodeName": "HoneypotNode1",
        "EcsInstanceId": "i-uf6eq0rlvu1mkh0p****"
      },
      "DeployTime": 1669363825000,
      "Status": "online",
      "Uuid": "49e25e0f-bb51-4a5a-a1b3-13a4ddaa****",
      "VpcId": "vpc-5gu8iu68w9b472jbb****"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 30,
    "Count": 20
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "4BC9E610-21BE-537F-82EF-144A60D5A970",
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
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

No change history