All Products
Search

This Product

    Security Center:ListAvailableHoneypot

    Document Center

    Security Center:ListAvailableHoneypot

    Last Updated:Jun 17, 2026

    Queries available honeypot configuration templates.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-sas:ListAvailableHoneypot

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    NodeId

    string

    No

    The ID of the honeypot management node.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    ListResult

    Data

    array<object>

    The list of honeypot image information.

    object

    HoneypotImageName

    string

    The name of the honeypot image.

    ruoyi
    HoneypotImageDisplayName

    string

    The display name of the honeypot image.

    RuoYi
    HoneypotImageId

    string

    The ID of the honeypot image.

    sha256:007095d6de9c7a343e9fc1f74a7efc9c5de9d5454789d2fa505a1b3fc62****
    HoneypotImageVersion

    string

    The image version of the honeypot.

    1.0.2
    HoneypotImageType

    string

    The type of the honeypot image.

    Web
    Proto

    string

    The protocol supported by the honeypot.

    tcp
    ServicePort

    string

    The service port of the honeypot.

    27017.0
    Multiports

    string

    The ports supported by the honeypot. The value is in JSON format and contains the following fields:

    • log_type: the log type.

    • proto: the supported protocol.

    • description: the description.

    • ports: the set of supported ports.

    • port_str: the supported ports as a string.

    • type: the type.

    [{"log_type":"web","proto":"tcp","description":"webServerPort","ports":[80.0],"port_str":"80","type":"web"}]
    Template

    string

    The honeypot configuration parameter template.

    {}
    Count

    integer

    The number of honeypot images.

    22
    Success

    boolean

    Indicates whether the call was successful. Valid values:

    • true: The call was successful.

    • false: The call failed.

    true
    Code

    string

    The result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.

    200
    Message

    string

    The detailed information of the error code.

    successful
    RequestId

    string

    The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.

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

    integer

    The HTTP status code.

    200

    Examples

    Success response

    JSON format

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

    Error code

    Error message

    Description
    500 ServerError ServerError
    403 NoPermission caller has no permission

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.