All Products
Search

This Product

    Security Center:ListHoneypotProbe

    Document Center

    Security Center:ListHoneypotProbe

    Last Updated:Jun 15, 2026

    Queries the list of honeypot probes.

    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:ListHoneypotProbe

    get

    *HoneypotProbe

    acs:yundun-sas:{#regionId}:{#accountId}:honeypotprobe/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProbeStatus

    string

    No

    The probe status. Valid values:

    • installed: Installation succeeded.

    • install_failed: Installation failed.

    • online: Normal.

    • offline: Offline.

    • unnormal: Service exception.

    • unprobe: Unauthorized.

    • uninstalling: Uninstalling.

    • uninstalled: Uninstallation succeeded.

    • uninstall_failed: Uninstallation failed.

    • not_exist: Not installed.

    online
    DisplayName

    string

    No

    The name of the probe.

    probe-test
    ProbeType

    string

    No

    The probe type. Valid values:

    • host_probe: host probe

    • vpc_black_hole_probe: VPC blackhole probe.

    host_probe
    Lang

    string

    No

    The language of the request and response. Default value: zh. Valid values:

    • zh: Chinese

    • en: English.

    en
    CurrentPage

    integer

    No

    The page number of the page to return. Minimum value: 1. Default value: 1.

    1
    PageSize

    integer

    No

    The maximum number of entries to return on each page in a paged query. Default value: 20. If you leave this parameter empty, 20 entries are returned per page during paging.

    Note

    Do not leave PageSize empty.

    20

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    List

    array<object>

    The list of honeypot probe data.

    array<object>

    The honeypot probe data.

    ProbeId

    string

    The probe ID.

    4d167bb3-dd09-4a6a-a179-d5d6a5b0****
    ProbeType

    string

    The probe type. Valid values:

    • host_probe: host probe

    • vpc_black_hole_probe: VPC blackhole probe.

    host_probe
    ProbeVersion

    string

    The probe version.

    18060096
    DisplayName

    string

    The probe name.

    prod-pinpoint-hd1b

    OsType

    string

    The operating system type of the probe instance. Valid values:

    • windows: Windows.

    • linux: Linux.

    windows
    HostIp

    string

    The local IP address bound to the probe.

    33.53.XX.XX
    ControlNode

    object

    The management node data.

    NodeId

    string

    The ID of the node.

    8ec9da17-c0e7-4642-aad6-defc9722****
    NodeName

    string

    The name of the node.

    HoneypotNode1
    EcsInstanceId

    string

    The ID of the Elastic Compute Service (ECS) instance.

    i-uf6eq0rlvu1mkh0p****
    DeployTime

    integer

    The deployment time.

    1669363825000
    Status

    string

    The probe status. Valid values:

    • installed: Installation succeeded.

    • install_failed: Installation failed.

    • online: Normal.

    • offline: Offline.

    • unnormal: Service exception.

    • unprobe: Unauthorized.

    • uninstalling: Uninstalling.

    • uninstalled: Uninstallation succeeded.

    • uninstall_failed: Uninstallation failed.

    • not_exist: Not installed.

    online
    Uuid

    string

    The UUID of the asset instance where the host probe is deployed.

    49e25e0f-bb51-4a5a-a1b3-13a4ddaa****
    VpcId

    string

    The ID of the VPC-connected instance where the VPC probe is deployed.

    vpc-5gu8iu68w9b472jbb****
    PageInfo

    object

    The pagination information.

    CurrentPage

    integer

    The current page number returned in the paged query during paging.

    1
    PageSize

    integer

    The number of honeypot probes displayed per page in the paged query during paging. Default value: 20.

    20
    TotalCount

    integer

    The total number of honeypot probes returned.

    30
    Count

    integer

    The number of honeypot probes displayed on the current page.

    20
    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 a failure.

    200
    Message

    string

    The response message.

    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.

    4BC9E610-21BE-537F-82EF-144A60D5A970
    HttpStatusCode

    integer

    The HTTP status code of the response.

    200

    Examples

    Success response

    JSON format

    {
  "List": [
    {
      "ProbeId": "4d167bb3-dd09-4a6a-a179-d5d6a5b0****",
      "ProbeType": "host_probe",
      "ProbeVersion": "18060096",
      "DisplayName": "prod-pinpoint-hd1b ",
      "OsType": "windows",
      "HostIp": "33.53.XX.XX",
      "ControlNode": {
        "NodeId": "8ec9da17-c0e7-4642-aad6-defc9722****",
        "NodeName": "HoneypotNode1",
        "EcsInstanceId": "i-uf6eq0rlvu1mkh0p****"
      },
      "DeployTime": 1669363825000,
      "Status": "online",
      "Uuid": "49e25e0f-bb51-4a5a-a1b3-13a4ddaa****",
      "VpcId": "vpc-5gu8iu68w9b472jbb****"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 30,
    "Count": 20
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "4BC9E610-21BE-537F-82EF-144A60D5A970",
  "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.