All Products
Search
Document Center

Security Center:StartHoneypot

Last Updated:Nov 25, 2024

Starts a 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:StartHoneypotupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
HoneypotIdstringYes

The ID of the honeypot.

Note You can call the ListHoneypot operation to query the IDs of honeypots.
dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****
LangstringNo

The language of the content in the request and response messages. 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.

123
HoneypotNamestring

The custom 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 custom configuration for the honeypot.

ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***
Statearray

The statuses of the honeypots.

Statestring

The status of the honeypot. Valid values:

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

The display name of the image.

Webmin
NodeIdstring

The ID of the management node.

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

The request ID.

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