文档

DescribeVpcHoneyPotList - 查询VPC蜜罐探针列表

更新时间:

查询VPC蜜罐探针列表。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeVpcHoneyPotListget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
VpcIdstring

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

说明 您可以调用 DescribeVpcList 接口获取 VPC ID。
vpc-d7o009q63fqy21r8u****
VpcNamestring

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

说明 您可以调用 DescribeVpcList 接口获取 VPC 名称。
abcnet
VpcRegionIdstring

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

说明 您可以调用 DescribeVpcList 接口获取 VPC 所在区域的 ID。
ap-southeast-2
HoneyPotExistenceboolean

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

  • true:已开通
  • false:未开通
true
PageSizeinteger

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

说明 建议 PageSize 取值不要为空。
20
CurrentPageinteger

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

2

返回参数

名称类型描述示例值
object
RequestIdstring

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

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

分页信息。

CurrentPageinteger

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

1
PageSizeinteger

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

20
TotalCountinteger

数据的总条数。

2
Countinteger

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

2
VpcHoneyPotDTOListarray<object>

云蜜罐实例的列表信息。

VpcHoneyPotDTOobject
VpcNamestring

云蜜罐实例的 VPC 名称。

abc-vpcname
VpcIdstring

云蜜罐实例的 VPC ID。

vpc-p0w223apdl49sr5zv****
HoneyPotEniInstanceIdstring

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

eni-p0whwgg7bing8b80****
CidrBlockstring

VPC 网段。

192.168.XX.XX/16
VpcStatusstring

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

  • Available:可用(正常运行状态)
  • Pending:配置中
Available
CreateTimelong

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

1607365213000
HoneyPotVpcSwitchIdstring

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

vsw-p0w7gdcfvn20tvdul****
HoneyPotExistenceboolean

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

  • true:已开通
  • false:未开通
true
VpcRegionIdstring

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

说明 Region ID 和区域名称的对应关系,请参见地域和可用区
ap-southeast-2
HoneyPotEcsInstanceStatusstring

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

  • Pending:创建中
  • Running:运行中
  • Starting:启动中
  • Stopping:停止中
  • Stopped:已停止
Running
HoneyPotInstanceStatusstring

云蜜罐实例状态。取值:

  • pending:创建中
  • deleting:删除中
  • off:关闭
  • suspending:暂停中
  • on:已开启
on
VpcSwitchIdListarray<object>

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

VpcSwitchInfoobject
VpcSwitchNamestring

交换机名称。

abc01
ZoneIdstring

交换机所在可用区 ID。

ap-southeast-2b
VpcSwitchIdstring

交换机 ID。

vsw-p0wdnyv4wzp6jkuu4****

示例

正常返回示例

JSON格式

{
  "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****"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
暂无变更历史