调用ListLogstashPlugins,获取所有或指定插件的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
elasticsearch:ListPlugin |
get |
*Logstash
|
无 | 无 |
请求语法
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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
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 |
| source |
string |
插件来源。 |
SYSTEM |
| name |
string |
插件名称。 |
logstash-filter-clone |
返回数据中还包含以下参数。
| 名称 | 类型 | 示例值 | 描述 |
| Headers | Struct | 返回头信息。 | |
| └X-Total-Count | Integer | 131 | 返回的插件数量。 |
└表示子参数。
示例
正常返回示例
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"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。