All Products
Search
Document Center

Security Center:GetHoneypotPreset

Last Updated:Feb 20, 2024

Queries the configurations of a specified honeypot template.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:GetHoneypotPresetRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
HoneypotPresetIdstringYes

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
LangstringNo

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

  • zh: Chinese
  • en: English
en

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

Dataobject

The information about the honeypot template.

HoneypotImageNamestring

The name of the honeypot image.

ruoyi
PresetNamestring

The custom name of the honeypot template.

ssh
HoneypotPresetIdstring

The ID of the honeypot template.

94fd8805-d178-4361-84d3-de47fb4e****
Metastring

The custom configuration of the honeypot template.

{"trojan_git":"zip","burp":"open","portrait_option":"true"}
FileInfoListobject []

An array that consists of the configurations of the uploaded file.

FileIdstring

The ID of the uploaded file.

HONEYPOT_FILE/1765_167040128****
FileNamestring

The name of the uploaded file.

HONEYPOT_FILE****
OssUrlstring

The download URL.

http://aegis****
NodeIdstring

The ID of the management node.

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

The name of the management node.

managerNodename
HoneypotImageDisplayNamestring

The display name of the honeypot image.

RuoYi
PresetTypestring

The type of the honeypot template. Valid values:

  • TEMP: automatically generated template
  • CUSTOM: custom template
  • DEFAULT: default template
CUSTOM
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.

success
RequestIdstring

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

38AFE393-88E8-5642-B3E2-D57C6E76025D
HttpStatusCodeinteger

The HTTP status code returned.

200

Examples

Sample success responses

JSONformat

{
  "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 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.