Security Center:CreateHoneypot - Security Center - Alibaba Cloud - Security Center

Creates a honeypot instance.

Operation description

Before calling this operation to create a honeypot instance, complete the following steps:

If no honeypot management node exists in your account, call the CreateHoneypotNode operation to create a honeypot management node.
Call the ListHoneypotNode operation to obtain the NodeId of the honeypot management node.
Use the obtained NodeId to call this operation (CreateHoneypot) to create a honeypot instance.

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

create

*HoneyPot

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

None

Request parameters

Parameter	Type	Required	Description	Example
HoneypotImageName	string	Yes	The honeypot image name. Note You can obtain this value from the HoneypotImageName field returned by the ListAvailableHoneypot operation.	HoneyPotImageName
HoneypotName	string	Yes	The custom name of the honeypot.	ruoyi
NodeId	string	Yes	The ID of the honeypot management node. Note Call the ListHoneypotNode operation to obtain this value.	a882e590-b87b-45a6-87b9-d0a3e5a0****
HoneypotImageId	string	Yes	The honeypot image ID. Note You can obtain this value from the HoneypotImageId field returned by the ListAvailableHoneypot operation.	sha256:ebc4c102ac407d53733c2373e8888a733ddce86f163ccbe7492ae1cbf26****
Meta	string	No	The custom configuration of the honeypot in JSON format. The following fields are included: trojan_git: The Git counter-intelligence method. Valid values: zip: Git source code package. web: .git folder leak. close: Shutdown. trojan_git_addr: The Git counter-intelligence endpoint. trojan_git.zip: The Git counter-intelligence trojan package. burp: The Burp counter-intelligence method. Valid values: open: Enabled. close: Shutdown. portrait_option: The tracing configuration. Valid values: false: Shutdown. true: Enabled.	{\"trojan_git\":\"close\",\"burp\":\"close\",\"portrait_option\":\"false\"}

Response elements

Element	Type	Description	Example
	object	PlainResult
Data	object	The honeypot information.
HoneypotId	string	The honeypot ID.	9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****
HoneypotName	string	The custom name of the honeypot.	ruoyi
ControlNodeName	string	The name of the honeypot management node.	managerNodename
HoneypotImageName	string	The honeypot image name.	tcp_proxy
PresetId	string	The ID of the honeypot custom parameter.	ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***
State	array	The honeypot status.
	string	The honeypot status. Valid values: starting: Starting. running: Normal. exited: Stopped. upgrade: Updating. deleting: Deleting. resetting: Resetting. created: Created. stopping: Stopping.	starting
HoneypotImageDisplayName	string	The display name of the honeypot image.	HoneyDisplayName
NodeId	string	The unique ID of the management node.	a882e590-b87b-45a6-87b9-d0a3e5a0****
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 request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	29874225-EAAC-5415-8501-32DD20FD29F6
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "Data": {
    "HoneypotId": "9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****",
    "HoneypotName": "ruoyi",
    "ControlNodeName": "managerNodename",
    "HoneypotImageName": "tcp_proxy",
    "PresetId": "ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***",
    "State": [
      "starting"
    ],
    "HoneypotImageDisplayName": "HoneyDisplayName",
    "NodeId": "a882e590-b87b-45a6-87b9-d0a3e5a0****"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "29874225-EAAC-5415-8501-32DD20FD29F6",
  "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.