ListHoneypot - Security Center - Alibaba Cloud Documentation Center

Queries the information about honeypots.

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

Request parameters

Parameter	Type	Required	Description	Example
HoneypotName	string	No	The name of the honeypot.	mx-rouyi
NodeName	string	No	The name of the management node.	honeypot_master
NodeId	string	No	The ID of the management node.	a882e590-b87b-45a6-87b9-d0a3e5a0****
HoneypotIds	array	No	The IDs of the honeypots.
HoneypotId	string	No	The ID of the honeypot.	76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	20

Response parameters

Parameter	Type	Description	Example
	object	PageResult
List	array<object>	An array that consists of the information about the honeypots.
List	object
HoneypotId	string	The ID of the honeypot.	76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****
HoneypotName	string	The name of the honeypot.	mx-rouyi
ControlNodeName	string	The name of the management node.	0804-pre
HoneypotImageName	string	The name of the honeypot image.	tcp_proxy
PresetId	string	The ID of the custom configuration for the honeypot.	a882e590-b87b-45a6-87b9-d0a3e5a0****
State	array	An array that consists of the status information about the honeypot.
State	string	The status of the honeypot. Valid values: starting: enabling running: normal exited: disabled upgrade: updating deleting: deleting resetting: resetting created: created stopping: stopping	running
HoneypotImageDisplayName	string	The display name of the honeypot image.	MongoDB
NodeId	string	The ID of the management node.	c94eff5b-ea48-4805-8b7f-e04d3509b117
HoneypotImageId	string	The ID of the honeypot image.	sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	69
Count	integer	The number of entries returned on the current page.	2
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 error message returned.	successful
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	C80AFF1F-CC20-502C-A4D4-F5433E529B69
HttpStatusCode	integer	The HTTP status code returned.	200

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "HoneypotId": "76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****",
      "HoneypotName": "mx-rouyi",
      "ControlNodeName": "0804-pre",
      "HoneypotImageName": "tcp_proxy",
      "PresetId": "a882e590-b87b-45a6-87b9-d0a3e5a0****",
      "State": [
        "running"
      ],
      "HoneypotImageDisplayName": "MongoDB",
      "NodeId": "c94eff5b-ea48-4805-8b7f-e04d3509b117",
      "HoneypotImageId": "sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 2
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "C80AFF1F-CC20-502C-A4D4-F5433E529B69",
  "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