All Products
Search
Document Center

Security Center:StartHoneypot

Last Updated:Feb 20, 2024

Starts a honeypot.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
HoneypotIdstringYes

The honeypot ID.

Note You can call the ListHoneypot operation to obtain IDs of honeypots.
dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****
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
Dataobject

The data returned.

HoneypotIdstring

The ID of the honeypot.

123
HoneypotNamestring

The name of the honeypot.

ruoyi
ControlNodeNamestring

The name of the management node to which the honeypot belongs.

managerNodename
HoneypotImageNamestring

The name of the image that is used for the honeypot.

tcp_proxy
PresetIdstring

The ID of the honeypot custom parameter.

ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***
Statearray

The status of the honeypot.

string

The status of the honeypot. Value:

  • starting: starting
  • running: normal
  • exited: closed
  • upgrade: updating
  • deleting: deleting
  • resetting: resetting
  • created: created
  • stopping: stopping
running
HoneypotImageDisplayNamestring

The display name of the honeypot image.

Webmin
NodeIdstring

The ID of the management node.

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

The ID of the request.

20456DD5-5CBF-5015-9173-12CA4246B***

Examples

Sample success responses

JSONformat

{
  "Data": {
    "HoneypotId": "123",
    "HoneypotName": "ruoyi",
    "ControlNodeName": "managerNodename",
    "HoneypotImageName": "tcp_proxy",
    "PresetId": "ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***",
    "State": [
      "running"
    ],
    "HoneypotImageDisplayName": "Webmin",
    "NodeId": "a882e590-b87b-45a6-87b9-d0a3e5a0****"
  },
  "RequestId": "20456DD5-5CBF-5015-9173-12CA4246B***"
}

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
No change history