调用DescribeVpcHoneyPotList接口查询蜜罐实例列表。

如果您在请求参数中只输入了Action,没有指定任一请求参数,云安全中心将返回所有的VPC列表(无论该VPC下是否创建了蜜罐实例)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVpcHoneyPotList

需要执行的操作。

取值:DescribeVpcHoneyPotList

VpcId String vpc-d7o009q63fqy21r8u****

指定要查询的蜜罐实例所在的VPC ID。

说明 您可以调用DescribeVpcList接口获取VPC ID。
VpcName String abcnet

指定要查询的蜜罐实例所在的VPC名称。

说明 您可以调用DescribeVpcList接口获取VPC名称。
VpcRegionId String ap-southeast-2

指定要查询的蜜罐实例所在的VPC区域ID。

说明 您可以调用DescribeVpcList接口获取VPC所在区域的ID。
HoneyPotExistence Boolean true

指定要查询的VPC列表是否开通了云蜜罐。取值:

  • true:已开通
  • false:未开通
PageSize Integer 20

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为20条,PageSize参数值为空时,将默认返回20条数据。

说明 建议PageSize取值不要为空。
CurrentPage Integer 2

指定分页查询时,当前页的页码。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
PageInfo Struct

分页信息。

Count Integer 2

分页查询时,当前页显示的数据条数。

CurrentPage Integer 1

分页查询时,当前页的页码。

PageSize Integer 20

分页查询时,每页最多显示的数据条数。

TotalCount Integer 2

数据的总条数。

RequestId String 4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2

阿里云为该请求生成的唯一标识符。

VpcHoneyPotDTOList Array of VpcHoneyPotDTO

云蜜罐实例的列表信息。

CidrBlock String 192.168.XX.XX/16

VPC网段。

CreateTime Long 1607365213000

创建VPC实例的时间。单位为毫秒。

HoneyPotEcsInstanceStatus String Running

云蜜罐实例对应的服务器状态。取值:

  • Pending:创建中
  • Running:运行中
  • Starting:启动中
  • Stopping:停止中
  • Stopped:已停止
HoneyPotEniInstanceId String eni-p0whwgg7bing8b80****

云蜜罐在VPC内创建的网卡实例ID。

HoneyPotExistence Boolean true

当前VPC实例是否开通了云蜜罐。取值:

  • true:已开通
  • false:未开通
HoneyPotInstanceStatus String on

云蜜罐实例状态。取值:

  • pending:创建中
  • deleting:删除中
  • off:关闭
  • suspending:暂停中
  • on:已开启
HoneyPotVpcSwitchId String vsw-p0w7gdcfvn20tvdul****

云蜜罐使用的网卡所在的交换机的ID。

VpcId String vpc-p0w223apdl49sr5zv****

云蜜罐实例的VPC ID。

VpcName String abc-vpcname

云蜜罐实例的VPC名称。

VpcRegionId String ap-southeast-2

云蜜罐实例的VPC所在区域的ID。

说明 Region ID和区域名称的对应关系,请参见地域和可用区
VpcStatus String Available

当前VPC实例的状态。取值:

  • Available:可用(正常运行状态)
  • Pending:配置中
VpcSwitchIdList Array of VpcSwitchInfo

当前VPC下的交换机列表信息。

VpcSwitchId String vsw-p0wdnyv4wzp6jkuu4****

交换机ID。

VpcSwitchName String abc01

交换机名称。

ZoneId String ap-southeast-2b

交换机所在可用区ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpcHoneyPotList
&<公共请求参数>

正常返回示例

XML格式

<DescribeVpcHoneyPotListResponse>
      <VpcHoneyPotDTOList>
            <HoneyPotEcsInstanceStatus>Running</HoneyPotEcsInstanceStatus>
            <VpcSwitchIdList>
                  <VpcSwitchName>abc01</VpcSwitchName>
                  <ZoneId>ap-southeast-2b</ZoneId>
                  <VpcSwitchId>vsw-p0wdnyv4wzp6jkuu4****</VpcSwitchId>
            </VpcSwitchIdList>
            <VpcId>vpc-p0w223apdl49sr5zv****</VpcId>
            <HoneyPotExistence>true</HoneyPotExistence>
            <HoneyPotInstanceStatus>on</HoneyPotInstanceStatus>
            <HoneyPotVpcSwitchId>vsw-p0w7gdcfvn20tvdul****</HoneyPotVpcSwitchId>
            <CreateTime>1607365213000</CreateTime>
            <VpcStatus>Available</VpcStatus>
            <VpcRegionId>ap-southeast-2</VpcRegionId>
            <CidrBlock>192.168.XX.XX/16</CidrBlock>
            <HoneyPotEniInstanceId>eni-p0whwgg7bing8b80****</HoneyPotEniInstanceId>
            <VpcName>abc-vpcname</VpcName>
      </VpcHoneyPotDTOList>
      <VpcHoneyPotDTOList>
            <VpcSwitchIdList>
                  <VpcSwitchName>abc02</VpcSwitchName>
                  <ZoneId>ap-southeast-2b</ZoneId>
                  <VpcSwitchId>vsw-p0wy1hvr3r8oi01hw****</VpcSwitchId>
            </VpcSwitchIdList>
            <VpcId>vpc-p0wjjpui2gerjmn2w****</VpcId>
            <HoneyPotExistence>false</HoneyPotExistence>
            <HoneyPotInstanceStatus>off</HoneyPotInstanceStatus>
            <CreateTime>1607467211000</CreateTime>
            <VpcStatus>Available</VpcStatus>
            <VpcRegionId>ap-southeast-2</VpcRegionId>
            <CidrBlock>192.168.XX.XX/16</CidrBlock>
            <VpcName>abc02-vpcname</VpcName>
      </VpcHoneyPotDTOList>
      <PageInfo>
            <TotalCount>2</TotalCount>
            <PageSize>20</PageSize>
            <CurrentPage>1</CurrentPage>
            <Count>2</Count>
      </PageInfo>
      <RequestId>4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2</RequestId>
</DescribeVpcHoneyPotListResponse>

JSON格式

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

错误码

访问错误中心查看更多错误码。