DescribeVpcHoneyPotList - Security Center - Alibaba Cloud Documentation Center

Queries honeypots.

Operation description

If you specify only the Action request parameter in your request, Security Center returns the list of all VPCs regardless of whether a honeypot is deployed on a VPC.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeVpcHoneyPotList	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
VpcId	string	No	The ID of the VPC on which the honeypot is deployed. Note You can call the DescribeVpcList operation to query the IDs of VPCs.	vpc-d7o009q63fqy21r8u****
VpcName	string	No	The name of the VPC. Note You can call the DescribeVpcList operation to query the names of VPCs.	abcnet
VpcRegionId	string	No	The region ID of the VPC. Note You can call the DescribeVpcList operation to query the region IDs of VPCs.	ap-southeast-2
HoneyPotExistence	boolean	No	Specifies whether the cloud honeypot feature is enabled for the VPCs. Valid values: true: yes false: no	true
PageSize	integer	No	The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The number of the page to return.	2

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	2
Count	integer	The number of entries returned on the current page.	2
VpcHoneyPotDTOList	array<object>	An array that consists of the honeypots.
VpcHoneyPotDTO	object
VpcName	string	The name of the VPC.	abc-vpcname
VpcId	string	The ID of the VPC.	vpc-p0w223apdl49sr5zv****
HoneyPotEniInstanceId	string	The ID of the elastic network interface (ENI) used by the honeypot 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: The VPC is normal and available. Pending: The VPC is being configured.	Available
CreateTime	long	The time at which the VPC was created. Unit: milliseconds.	1607365213000
HoneyPotVpcSwitchId	string	The ID of the vSwitch to which the ENI used by the honeypot is connected.	vsw-p0w7gdcfvn20tvdul****
HoneyPotExistence	boolean	Indicates whether the cloud honeypot feature is enabled for the VPC. Valid values: true: yes false: no	true
VpcRegionId	string	The region ID of the VPC. Note For more information about the mapping between region IDs and region names, see Regions and zones.	ap-southeast-2
HoneyPotEcsInstanceStatus	string	The status of the server on which the honeypot is deployed. Valid values: Pending: The server is being created. Running: The server is running. Starting: The server is being started. Stopping: The server is being stopped. Stopped: The server is stopped.	Running
HoneyPotInstanceStatus	string	The status of the honeypot. Valid values: pending: The honeypot is being created. deleting: The honeypot is being deleted. off: The honeypot is disabled. suspending: The honeypot is suspended. on: The honeypot is enabled.	on
VpcSwitchIdList	array<object>	An array that consists of the vSwitches in the VPC.
VpcSwitchInfo	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

Sample success responses

JSONformat

{
  "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
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history