ListHoneypot API Reference & Parameters - Security Center - Alibaba Cloud - Security Center

Queries a list of honeypots.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListHoneypot

get

*HoneyPot

acs:yundun-sas:{#regionId}:{#accountId}:honeypot/*

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 honeypot management node.	honeypot_master
NodeId	string	No	The ID of the honeypot management node.	a882e590-b87b-45a6-87b9-d0a3e5a0****
HoneypotIds	array	No	The list of honeypot IDs.
	string	No	The honeypot ID.	76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****
CurrentPage	integer	No	The page number of the current page in a paged query.	1
PageSize	integer	No	The maximum number of entries to return per page in a paged query.	20

Response elements

Element	Type	Description	Example
	object	PageResult
List	array<object>	The list of honeypot data.
	object
HoneypotId	string	The honeypot ID.	76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****
HoneypotName	string	The name of the honeypot.	mx-rouyi
ControlNodeName	string	The name of the honeypot management node.	0804-pre
HoneypotImageName	string	The name of the honeypot image.	tcp_proxy
PresetId	string	The ID of the custom honeypot parameter.	a882e590-b87b-45a6-87b9-d0a3e5a0****
State	array	The status of the honeypot.
	string	The status of the honeypot. Valid values: starting: Starting. running: Normal. exited: Stopped. 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 current page in a paged query.	1
PageSize	integer	The maximum number of entries to return per page in a paged query.	20
TotalCount	integer	The total number of entries.	69
Count	integer	The number of entries on the current page.	2
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Code	string	The result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.	200
Message	string	The detailed information about the error code.	successful
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for the request. You can use this ID to troubleshoot issues.	C80AFF1F-CC20-502C-A4D4-F5433E529B69
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.