All Products
Search
Document Center

Security Center:UpdateHoneypot

Last Updated:Nov 13, 2024

Modifies the configuration of a specified honeypot.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:UpdateHoneypotupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MetastringNo

The custom configuration of the honeypot.

Note You can call the ListAvailableHoneypot operation to query the configurations of honeypots from the Template response parameter.
{\"burp\":\"open\",\"webshell\":\"open\",\"trojan_git\":\"close\",\"portrait_option\":\"true\"}
HoneypotIdstringYes

The ID of the honeypot.

Note You can call the ListHoneypot operation to query the IDs of honeypots.
945607c2ae2a1a737c04599d6608065688bfc6048d9b9d306ce8dc8191c278b4
HoneypotNamestringNo

The custom name of the honeypot.

ExtMail
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

Dataobject

The information about the honeypot.

HoneypotIdstring

The ID of the honeypot.

9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****
HoneypotNamestring

The custom name of the honeypot.

hyl-phpmyadmin
HoneypotImageNamestring

The name of the honeypot image.

webpage
PresetIdstring

The ID of the custom configuration for the honeypot.

868a7579-00b5-4a74-999d-8bd3f411e8a3
Statearray

An array that consists of the status information about the honeypot.

Statestring

The status of the honeypot.

running
HoneypotImageDisplayNamestring

The display name of the honeypot image.

Webmin
NodeIdstring

The ID of the management node.

a882e590-b87b-45a6-87b9-d0a3e5a0****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codestring

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
Messagestring

The message returned.

successful
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

3B323ADD-6CF8-51F6-9047-2F0A4E3F5EFD
HttpStatusCodeinteger

The HTTP status code returned.

200

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-01The Error code has changed. The request parameters of the API has changedView Change Details