文档

ListHoneypotPreset - 查询蜜罐模板列表

更新时间:

查询蜜罐模板列表。

调试

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

授权信息

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

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

请求参数

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

蜜罐镜像名称。

ruoyi
PresetNamestring

蜜罐模板自定义名称。

mx-rouyi
NodeNamestring

蜜罐管理节点名称。

Node1
NodeIdstring

蜜罐管理节点唯一 ID。

d892b4fe-af0d-4486-ab2a-8a518045****
Langstring

请求和接收消息的语言类型。取值:

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

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

1
PageSizeinteger

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

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

返回参数

名称类型描述示例值
object

请求返回数据。

Listobject []

蜜罐模板列表。

HoneypotImageNamestring

蜜罐镜像名称。

metabase
PresetNamestring

蜜罐模板自定义名称。

WebMin-online
HoneypotPresetIdstring

蜜罐模板唯一 ID。

3cc04a47-7229-418c-8101-f10a2887****
NodeIdstring

管理节点唯一 ID。

c94eff5b-ea48-4805-8b7f-e04d3509****
ControlNodeNamestring

蜜罐管理节点名称。

node1
HoneypotImageDisplayNamestring

蜜罐镜像展示名称。

Metabase
PresetTypestring

模板类型。取值:

  • TEMP:自动生成
  • CUSTOM:自定义
  • DEFAULT:默认模板
CUSTOM
PageInfoobject

页面显示的信息。

CurrentPageinteger

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

1
PageSizeinteger

分页查询时,每页显示的蜜罐模板数量。默认值为 20,表示每页显示 20 条蜜罐模板数据。

20
TotalCountinteger

查询到的蜜罐模板数据的总数量。

55
Countinteger

当前页面显示的蜜罐模板信息的数量。

20
Successboolean

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

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

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

200
Messagestring

请求结果返回信息。

successful
RequestIdstring

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

0C656B33-0D6B-5953-A26A-D766BD75B44A
HttpStatusCodeinteger

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

200

示例

正常返回示例

JSON格式

{
  "List": [
    {
      "HoneypotImageName": "metabase",
      "PresetName": "WebMin-online",
      "HoneypotPresetId": "3cc04a47-7229-418c-8101-f10a2887****",
      "NodeId": "c94eff5b-ea48-4805-8b7f-e04d3509****",
      "ControlNodeName": "node1",
      "HoneypotImageDisplayName": "Metabase",
      "PresetType": "CUSTOM"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 55,
    "Count": 20
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "0C656B33-0D6B-5953-A26A-D766BD75B44A",
  "HttpStatusCode": 200
}

错误码

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

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

变更历史

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