文档

ListHoneypot - 获取蜜罐列表

更新时间:

查询蜜罐信息列表。

调试

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

授权信息

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

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

请求参数

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

蜜罐名称。

mx-rouyi
NodeNamestring

蜜罐管理节点名称。

honeypot_master
NodeIdstring

蜜罐管理节点 ID。

a882e590-b87b-45a6-87b9-d0a3e5a0****
HoneypotIdsarray

蜜罐 ID 集合。

HoneypotIdstring

蜜罐 ID。

76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****
CurrentPageinteger

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

1
PageSizeinteger

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

20

返回参数

名称类型描述示例值
object

PageResult

Listarray<object>

蜜罐数据列表。

Listobject
HoneypotIdstring

蜜罐 ID。

76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****
HoneypotNamestring

蜜罐名称。

mx-rouyi
ControlNodeNamestring

蜜罐管理节点名称。

0804-pre
HoneypotImageNamestring

蜜罐镜像名称。

tcp_proxy
PresetIdstring

蜜罐自定义参数 ID。

a882e590-b87b-45a6-87b9-d0a3e5a0****
Statearray

蜜罐状态。

Statestring

蜜罐状态。取值:

  • starting:开启中
  • running:正常
  • exited:关闭
  • upgrade:更新中
  • deleting:正在删除中
  • resetting:重置中
  • created:完成创建
  • stopping:停止中
running
HoneypotImageDisplayNamestring

蜜罐镜像显示名称。

MongoDB
NodeIdstring

管理节点 ID。

c94eff5b-ea48-4805-8b7f-e04d3509b117
HoneypotImageIdstring

蜜罐镜像 ID。

sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4
PageInfoobject

分页信息。

CurrentPageinteger

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

1
PageSizeinteger

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

20
TotalCountinteger

数据的总条数。

69
Countinteger

当前页显示的数据条数。

2
Successboolean

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

  • true:接口调用成功。
  • false:接口调用失败。
true
Codestring

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

200
Messagestring

错误码的详细信息。

successful
RequestIdstring

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

C80AFF1F-CC20-502C-A4D4-F5433E529B69
HttpStatusCodeinteger

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "List": [
    {
      "HoneypotId": "76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****",
      "HoneypotName": "mx-rouyi",
      "ControlNodeName": "0804-pre",
      "HoneypotImageName": "tcp_proxy",
      "PresetId": "a882e590-b87b-45a6-87b9-d0a3e5a0****",
      "State": [
        "running"
      ],
      "HoneypotImageDisplayName": "MongoDB",
      "NodeId": "c94eff5b-ea48-4805-8b7f-e04d3509b117",
      "HoneypotImageId": "sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 2
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "C80AFF1F-CC20-502C-A4D4-F5433E529B69",
  "HttpStatusCode": 200
}

错误码

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

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

变更历史

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