All Products
Search
Document Center

Security Center:ListAvailableHoneypot

Last Updated:Feb 20, 2024

Queries the information about available honeypot templates.

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

Request parameters

ParameterTypeRequiredDescriptionExample
NodeIdstringNo

The ID of the management node to which the honeypot is deployed.

4341018b-8e01-43f6-b1d2-af29a2a4****

Response parameters

ParameterTypeDescriptionExample
object

ListResult

Dataobject []

An array consisting of the information about the images that are used for the honeypot.

HoneypotImageNamestring

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

ruoyi
HoneypotImageDisplayNamestring

The display name of the image.

RuoYi
HoneypotImageIdstring

The ID of the image.

sha256:007095d6de9c7a343e9fc1f74a7efc9c5de9d5454789d2fa505a1b3fc62****
HoneypotImageVersionstring

The version of the image.

1.0.2
HoneypotImageTypestring

The type of the image.

Web
Protostring

The protocol that is supported by the honeypot.

tcp
ServicePortstring

The service port of the honeypot.

27017.0
Multiportsstring

The port that is supported by the honeypot. The value is in the JSON format. Valid values:

  • log_type: the log type
  • proto: the supported protocol
  • description: the description
  • ports: the supported ports
  • port_str: the supported port number of the string type
  • type: the type
[{"log_type":"web","proto":"tcp","description":"webServerPort","ports":[80.0],"port_str":"80","type":"web"}]
Templatestring

The configuration template of the honeypot.

{}
Countinteger

The number of images that are used for the honeypot.

22
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 error message returned.

successful
RequestIdstring

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

6C24D883-984D-52FD-BB66-5F89F86E4837
HttpStatusCodeinteger

The HTTP status code returned.

200

Examples

Sample success responses

JSONformat

{
  "Data": [
    {
      "HoneypotImageName": "ruoyi",
      "HoneypotImageDisplayName": "RuoYi",
      "HoneypotImageId": "sha256:007095d6de9c7a343e9fc1f74a7efc9c5de9d5454789d2fa505a1b3fc62****",
      "HoneypotImageVersion": "1.0.2",
      "HoneypotImageType": "Web",
      "Proto": "tcp",
      "ServicePort": "27017.0",
      "Multiports": "[{\"log_type\":\"web\",\"proto\":\"tcp\",\"description\":\"webServerPort\",\"ports\":[80.0],\"port_str\":\"80\",\"type\":\"web\"}]",
      "Template": "{}"
    }
  ],
  "Count": 22,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "6C24D883-984D-52FD-BB66-5F89F86E4837",
  "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.