ListHoneypotPreset - Security Center - Alibaba Cloud Documentation Center

Queries honeypot templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListHoneypotPreset	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
HoneypotImageName	string	No	The name of the honeypot image.	ruoyi
PresetName	string	No	The custom name of the honeypot template.	mx-rouyi
NodeName	string	No	The name of the management node.	Node1
NodeId	string	No	The ID of the management node.	d892b4fe-af0d-4486-ab2a-8a518045****
Lang	string	No	The language of the content within the request and response. Valid values: zh: Chinese en: English	en
CurrentPage	integer	No	The number of the page to return. 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 data returned.
List	object []	An array that consists of the honeypot templates.
HoneypotImageName	string	The name of the honeypot image.	metabase
PresetName	string	The custom name of the honeypot template.	WebMin-online
HoneypotPresetId	string	The ID of the honeypot template.	3cc04a47-7229-418c-8101-f10a2887****
NodeId	string	The ID of the management node.	c94eff5b-ea48-4805-8b7f-e04d3509****
ControlNodeName	string	The name of the management node.	node1
HoneypotImageDisplayName	string	The display name of the honeypot image.	Metabase
PresetType	string	The type of the honeypot template. Valid values: TEMP: automatically generated template CUSTOM: custom template DEFAULT: default template	CUSTOM
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.	55
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 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.	0C656B33-0D6B-5953-A26A-D766BD75B44A
HttpStatusCode	integer	The HTTP status code returned.	200

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "HoneypotImageName": "metabase",
      "PresetName": "WebMin-online",
      "HoneypotPresetId": "3cc04a47-7229-418c-8101-f10a2887****",
      "NodeId": "c94eff5b-ea48-4805-8b7f-e04d3509****",
      "ControlNodeName": "node1",
      "HoneypotImageDisplayName": "Metabase",
      "PresetType": "CUSTOM"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 55,
    "Count": 20
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "0C656B33-0D6B-5953-A26A-D766BD75B44A",
  "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