Use CreateHoneypotPreset API to Deploy Honeypot Templates - Security Center - Alibaba Cloud - Security Center

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

create

*HoneypotPreset

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

None

Request parameters

Parameter	Type	Required	Description	Example
HoneypotImageName	string	Yes	The name of the honeypot image.	webmin
PresetName	string	Yes	The custom name of the honeypot template.	WebMin-online
Meta	string	Yes	The custom configurations of the honeypot template. The value is a JSON string that contains the following fields: portrait_option: Social Source Tracing burp: Burp-specific Defense trojan_git: Git-specific Defense	{"burp":"close","trojan_git":"close","portrait_option":"true"}
NodeId	string	Yes	The ID of the management node to which you want to deploy honeypots. Note You can call the ListHoneypotNode operation to query the IDs of management nodes.	9373fe59-74d5-4505-bb24-c85352fb****
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The data returned.
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.	7C1C6E65-C8B9-54C9-9F92-2F5E51C4E16D
HttpStatusCode	integer	The HTTP status code returned.	200
HoneypotPreset	object	The creation result.
HoneypotPresetId	string	The ID of the honeypot template.	d6ece172-34d9-4942-99a4-b309cb55xxxx

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "7C1C6E65-C8B9-54C9-9F92-2F5E51C4E16D",
  "HttpStatusCode": 200,
  "HoneypotPreset": {
    "HoneypotPresetId": "d6ece172-34d9-4942-99a4-b309cb55xxxx"
  }
}

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.