ListLogstashPlugins - 获取Logstash插件列表

更新时间:
复制 MD 格式

调用ListLogstashPlugins,获取所有或指定插件的详细信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ListPlugin

get

*Logstash

acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}

无 无

请求语法

GET /openapi/logstashes/{InstanceId}/plugins HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID。

ls-cn-oew1qbgl****

请求参数

名称

类型

必填

描述

示例值

name

string

否

插件名称。

logstash-filter-clone

page

integer

否

插件列表的分页数。默认值:1,最小值:1,最大值:200。

10

size

integer

否

分页查询时设置的每页条数。最小值:1,最大值:200。

3

source

string

否

插件来源。可选值:

  • USER:自定义插件

  • SYSTEM:系统预置插件

USER

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

99407AB-2FA9-489E-A259-40CF6DCC****

Result

array<object>

返回结果。

object

description

string

插件描述。

The clone filter is for duplicating events.

specificationUrl

string

插件的说明文档地址。

https://xxx.html

state

string

插件的状态。支持:

  • INSTALLED:已安装

  • UNINSTALLED:未安装

  • INSTALLING:安装中

  • UNINSTALLING:卸载中

  • UPGRADING:升级中

  • FAILED:安装失败

  • UNKNOWN:集群失联无法获取到创建状态

INSTALLED

source

string

插件来源。

SYSTEM

name

string

插件名称。

logstash-filter-clone

返回数据中还包含以下参数。

名称类型示例值描述
HeadersStruct返回头信息。
└X-Total-CountInteger131返回的插件数量。
说明

└表示子参数。

示例

正常返回示例

JSON格式

{
  "RequestId": "99407AB-2FA9-489E-A259-40CF6DCC****\t",
  "Result": [
    {
      "description": "The clone filter is for duplicating events.",
      "specificationUrl": "https://xxx.html",
      "state": "INSTALLED",
      "source": "SYSTEM",
      "name": "logstash-filter-clone"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。