All Products
Search

This Product

    Security Center:DescribeVpcHoneyPotList

    Document Center

    Security Center:DescribeVpcHoneyPotList

    Last Updated:Jun 17, 2026

    Queries the list of VPC honeypot probes.

    Operation description

    If you specify only the Action parameter without specifying any other request parameters, Security Center returns the list of all VPCs regardless of whether honeypot instances are created in the VPCs.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VpcId

    string

    No

    The ID of the VPC in which the honeypot instance that you want to query resides.

    Note

    You can call the DescribeVpcList operation to obtain the VPC ID.

    vpc-d7o009q63fqy21r8u****
    VpcName

    string

    No

    The name of the VPC in which the honeypot instance that you want to query resides.

    Note

    You can call the DescribeVpcList operation to obtain the VPC name.

    abcnet
    VpcRegionId

    string

    No

    The region ID of the VPC in which the honeypot instance that you want to query resides.

    Note

    You can call the DescribeVpcList operation to obtain the region ID of the VPC.

    ap-southeast-2
    HoneyPotExistence

    boolean

    No

    Specifies whether the VPCs to query have cloud honeypot enabled. Valid values:

    • true: enabled

    • false: disabled

    true
    PageSize

    integer

    No

    The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned per page.

    Note

    We recommend that you specify this parameter.

    20
    CurrentPage

    integer

    No

    The page number. Pages start from page 1.

    2

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2
    PageInfo

    object

    The pagination information.

    CurrentPage

    integer

    The page number.

    1
    PageSize

    integer

    The number of entries per page.

    20
    TotalCount

    integer

    The total number of entries.

    2
    Count

    integer

    The number of entries on the current page.

    2
    VpcHoneyPotDTOList

    array<object>

    The information about cloud honeypot instances.

    array<object>

    VpcName

    string

    The name of the VPC in which the cloud honeypot instance resides.

    abc-vpcname
    VpcId

    string

    The ID of the VPC in which the cloud honeypot instance resides.

    vpc-p0w223apdl49sr5zv****
    HoneyPotEniInstanceId

    string

    The ID of the elastic network interface (ENI) that the cloud honeypot created in the VPC.

    eni-p0whwgg7bing8b80****
    CidrBlock

    string

    The CIDR block of the VPC.

    192.168.XX.XX/16
    VpcStatus

    string

    The status of the VPC. Valid values:

    • Available: normal

    • Pending: being configured

    Available
    CreateTime

    integer

    The time when the VPC was created. Unit: milliseconds.

    1607365213000
    HoneyPotVpcSwitchId

    string

    The ID of the vSwitch to which the ENI used by the cloud honeypot belongs.

    vsw-p0w7gdcfvn20tvdul****
    HoneyPotExistence

    boolean

    Indicates whether the VPC has cloud honeypot enabled. Valid values:

    • true: enabled

    • false: disabled

    true
    VpcRegionId

    string

    The region ID of the VPC in which the cloud honeypot instance resides.

    Note

    For the mapping between region IDs and region names, see Regions and zones.

    ap-southeast-2
    HoneyPotEcsInstanceStatus

    string

    The status of the Elastic Compute Service (ECS) instance that corresponds to the cloud honeypot instance. Valid values:

    • Pending: being created

    • Running: running

    • Starting: starting

    • Stopping: stopping

    • Stopped: stopped

    Running
    HoneyPotInstanceStatus

    string

    The status of the cloud honeypot instance. Valid values:

    • pending: being created

    • deleting: being deleted

    • off: disabled

    • suspending: being suspended

    • on: enabled

    on
    VpcSwitchIdList

    array<object>

    The information about vSwitches in the VPC.

    object

    VpcSwitchName

    string

    The name of the vSwitch.

    abc01
    ZoneId

    string

    The zone ID of the vSwitch.

    ap-southeast-2b
    VpcSwitchId

    string

    The ID of the vSwitch.

    vsw-p0wdnyv4wzp6jkuu4****

    Examples

    Success response

    JSON format

    {
  "RequestId": "4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "VpcHoneyPotDTOList": [
    {
      "VpcName": "abc-vpcname",
      "VpcId": "vpc-p0w223apdl49sr5zv****",
      "HoneyPotEniInstanceId": "eni-p0whwgg7bing8b80****",
      "CidrBlock": "192.168.XX.XX/16",
      "VpcStatus": "Available",
      "CreateTime": 1607365213000,
      "HoneyPotVpcSwitchId": "vsw-p0w7gdcfvn20tvdul****",
      "HoneyPotExistence": true,
      "VpcRegionId": "ap-southeast-2",
      "HoneyPotEcsInstanceStatus": "Running",
      "HoneyPotInstanceStatus": "on",
      "VpcSwitchIdList": [
        {
          "VpcSwitchName": "abc01",
          "ZoneId": "ap-southeast-2b",
          "VpcSwitchId": "vsw-p0wdnyv4wzp6jkuu4****"
        }
      ]
    }
  ]
}

    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.