文档

ListHoneypotProbe - 查询蜜罐探针列表

更新时间:

查询蜜罐探针列表。

调试

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

授权信息

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

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

请求参数

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

探针状态。取值:

  • installed:安装成功
  • install_failed:安装失败
  • online:正常
  • offline:离线
  • unnormal:服务异常
  • unprobe:未授权
  • uninstalling:卸载中
  • uninstalled:卸载成功
  • uninstall_failed:卸载失败
  • not_exist:未安装
online
DisplayNamestring

探针名称

probe-test
ProbeTypestring

探针类型。取值:

  • host_probe:主机探针
  • vpc_black_hole_probe:VPC 黑洞探针
host_probe
Langstring

请求和接收消息的语言类型,默认值为 zh。取值:

  • zh:中文
  • en:英文
en
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。起始值为 1。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

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

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

返回参数

名称类型描述示例值
object

请求返回数据。

Listobject []

蜜罐探针数据列表。

ProbeIdstring

探针 ID。

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

探针类型。取值:

  • host_probe:主机探针
  • vpc_black_hole_probe:VPC 黑洞探针
host_probe
ProbeVersionstring

探针版本。

18060096
DisplayNamestring

探针名称。

prod-pinpoint-hd1b
OsTypestring

探针实例的操作系统类型,取值范围:

  • windows:操作系统类型为 Windows。
  • linux:操作系统类型为 Linux。
windows
HostIpstring

探针绑定的本地地址。

33.53.XX.XX
ControlNodeobject

管理节点数据。

NodeIdstring

节点 ID。

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

节点名称。

HoneypotNode1
EcsInstanceIdstring

ECS 的实例 ID。

i-uf6eq0rlvu1mkh0p****
DeployTimelong

部署时间。

1669363825000
Statusstring

探针状态。取值:

  • installed:安装成功
  • install_failed:安装失败
  • online:正常
  • offline:离线
  • unnormal:服务异常
  • unprobe:未授权
  • uninstalling:卸载中
  • uninstalled:卸载成功
  • uninstall_failed:卸载失败
  • not_exist:未安装
online
Uuidstring

主机探针所在资产实例的 UUID。

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

vpc 探针所在 vpc 实例的 ID。

vpc-5gu8iu68w9b472jbb****
PageInfoobject

页面显示的信息。

CurrentPageinteger

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

1
PageSizeinteger

分页查询时,每页显示的蜜罐探针的数量。默认值为 20,表示每页显示 20 条蜜罐探针信息。

20
TotalCountinteger

查询到的蜜罐探针数据的总数量。

30
Countinteger

当前页显示的蜜罐探针的数量。

20
Successboolean

接口调用是否成功。取值:

  • true:成功
  • false:失败
true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

请求结果返回信息。

successful
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

请求数据结果的 HTTP 状态码。

200

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈