Update Honeypot Settings with UpdateHoneypot API - Security Center - Alibaba Cloud - Security Center

Modifies the configuration of a specified honeypot.

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

update

*HoneyPot

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

None

Request parameters

Parameter	Type	Required	Description	Example
Meta	string	No	The custom configuration of the honeypot. Note The value of this parameter is obtained from the Template field returned by the ListAvailableHoneypot operation.	{\"burp\":\"open\",\"webshell\":\"open\",\"trojan_git\":\"close\",\"portrait_option\":\"true\"}
HoneypotId	string	Yes	The honeypot ID. Note You can call the ListHoneypot operation to obtain this value.	945607c2ae2a1a737c04599d6608065688bfc6048d9b9d306ce8dc8191c*****
HoneypotName	string	No	The custom name of the honeypot.	ExtMail
Lang	string	No	The language of the content in the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The honeypot information.
HoneypotId	string	The honeypot ID.	9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****
HoneypotName	string	The custom name of the honeypot.	hyl-phpmyadmin
HoneypotImageName	string	The name of the honeypot image.	webpage
PresetId	string	The ID of the custom honeypot parameter.	868a7579-00b5-4a74-999d-8bd3f411e8a3
State	array	The status of the honeypot.
	string	The status of the honeypot.	running
HoneypotImageDisplayName	string	The display name of the honeypot image.	Webmin
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 response message.	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.	3B323ADD-6CF8-51F6-9047-2F0A4E3F5EFD
HttpStatusCode	integer	The HTTP status code of the response.	200

Examples

Success response

JSON format

{
  "Data": {
    "HoneypotId": "9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****",
    "HoneypotName": "hyl-phpmyadmin",
    "HoneypotImageName": "webpage",
    "PresetId": "868a7579-00b5-4a74-999d-8bd3f411e8a3",
    "State": [
      "running"
    ],
    "HoneypotImageDisplayName": "Webmin",
    "NodeId": "a882e590-b87b-45a6-87b9-d0a3e5a0****"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "3B323ADD-6CF8-51F6-9047-2F0A4E3F5EFD",
  "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.