Security Center:GetHoneypotPreset - Security Center - Alibaba Cloud - Security Center

Retrieves the configuration of a specified honeypot template.

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:GetHoneypotPreset

get

*HoneypotPreset

acs:yundun-sas:{#regionId}:{#accountId}:honeypotpreset/{#HoneypotPresetId}

None

Request parameters

Parameter	Type	Required	Description	Example
HoneypotPresetId	string	Yes	The ID of the honeypot template. Note You can call the ListHoneypotPreset operation to query the IDs of honeypot templates.	207ca117-44b9-495d-84e7-50289b4cxxxx
Lang	string	No	The language of the request and response content. Default value: zh. Valid values: zh: Chinese en: English	en

Response elements

Element	Type	Description	Example
	object	The data returned.
Data	object	The information about the honeypot template.
HoneypotImageName	string	The name of the honeypot image.	ruoyi
PresetName	string	The custom name of the honeypot template.	ssh
HoneypotPresetId	string	The ID of the honeypot template.	94fd8805-d178-4361-84d3-de47fb4e****
Meta	string	The custom configuration of the honeypot template.	{"trojan_git":"zip","burp":"open","portrait_option":"true"}
FileInfoList	array<object>	The uploaded file configurations.
	object	The uploaded file details.
FileId	string	The ID of the uploaded file.	HONEYPOT_FILE/1765_167040128****
FileName	string	The name of the uploaded file.	HONEYPOT_FILE****
OssUrl	string	The download URL.	http://aegis****
NodeId	string	The ID of the management node.	a882e590-b87b-45a6-87b9-d0a3e5a0****
ControlNodeName	string	The name of the management node.	managerNodename
HoneypotImageDisplayName	string	The display name of the honeypot image.	RuoYi
PresetType	string	The type of the honeypot template. Valid values: TEMP: automatically generated template CUSTOM: custom template DEFAULT: default template	CUSTOM
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The status code. A value of 200 indicates success. Other values indicate failure.	200
Message	string	The message returned.	success
RequestId	string	The request ID, used for troubleshooting.	38AFE393-88E8-5642-B3E2-D57C6E76025D
HttpStatusCode	integer	The HTTP status code returned.	200

Examples

Success response

JSON format

{
  "Data": {
    "HoneypotImageName": "ruoyi",
    "PresetName": "ssh",
    "HoneypotPresetId": "94fd8805-d178-4361-84d3-de47fb4e****",
    "Meta": "{\"trojan_git\":\"zip\",\"burp\":\"open\",\"portrait_option\":\"true\"}",
    "FileInfoList": [
      {
        "FileId": "HONEYPOT_FILE/1765_167040128****",
        "FileName": "HONEYPOT_FILE****",
        "OssUrl": "http://aegis****"
      }
    ],
    "NodeId": "a882e590-b87b-45a6-87b9-d0a3e5a0****",
    "ControlNodeName": "managerNodename",
    "HoneypotImageDisplayName": "RuoYi",
    "PresetType": "CUSTOM"
  },
  "Success": true,
  "Code": "200",
  "Message": "success",
  "RequestId": "38AFE393-88E8-5642-B3E2-D57C6E76025D",
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.