All Products
Search
Document Center

Security Center:StopHoneypot

Last Updated:Feb 20, 2024

Stops 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.
444c699ac151b183b04b562b1dc02639d504c9d097246a322de75c963fe*****
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 response parameters.

Dataobject

The data returned.

HoneypotIdstring

The ID of the honeypot.

9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****
HoneypotNamestring

The name of the honeypot.

hyl-phpmya****
ControlNodeNamestring

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

managerNoden****
HoneypotImageNamestring

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

metabase
PresetIdstring

The ID of the honeypot custom parameter.

868a7579-00b5-4a74-999d-8bd3f411****
Statearray

The statuses of the honeypots.

string

The status of the honeypot.

running
HoneypotImageDisplayNamestring

The display name of the image.

RuoYi
NodeIdstring

The ID of the management node.

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

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The response code. 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 returned message.

successful
RequestIdstring

The request ID.

D65AADFC-1D20-5A6A-8F6A-9FA53C*****
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "HoneypotId": "9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****",
    "HoneypotName": "hyl-phpmya****",
    "ControlNodeName": "managerNoden****",
    "HoneypotImageName": "metabase",
    "PresetId": "868a7579-00b5-4a74-999d-8bd3f411****",
    "State": [
      "running"
    ],
    "HoneypotImageDisplayName": "RuoYi",
    "NodeId": "a882e590-b87b-45a6-87b9-d0a3e5a0****"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "D65AADFC-1D20-5A6A-8F6A-9FA53C*****",
  "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
No change history