ListLogstash_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:ListLogstash
List
全部资源
*

请求语法

GET /openapi/logstashes HTTP/1.1

请求参数

字段名称字段详情
pageinteger<int32>

实例列表的页码。默认值:1。

示例值:1
sizeinteger<int32>

分页查询时设置的每页条数。默认值:20。

示例值:10
descriptionstring

实例名称,支持模糊查询。例如查询名称为 abc 的实例,则可能返回名称为 abc、abcde、xyabc、xabcy 的所有实例。

示例值:ls-cn-abc
instanceIdstring

实例 ID。

示例值:ls-cn-n6w1o5jq****参考取值来源:
    ListInstance
    UpdateInstance
    DiagnoseInstance
    DescribeInstance
    RestartInstance
versionstring

实例版本。

示例值:5.5.3_with_X-Pack
resourceGroupIdstring

资源组 ID。

示例值:rg-acfm2h5vbzd****
tagsstring

实例标签。

示例值:[{"tagKey":"key1","tagValue":"value1"}]

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:AC442F2F-5068-4434-AA21-E78947A9****
Headersobject

请求头信息。

Resultarray<object>

当前请求返回的实例列表。

返回说明

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

名称类型示例值描述
enablePublicBooleanfalse是否开启公网访问,默认为 false。
commodityCodeStringelasticsearch_logstash_post产品代码。
endTimeLong4749897600000包年包月实例,最后的失效时间。
clusterTasksArray[]实例的任务列表。
resourceGroupIdStringrg-acfm2h5vbzd****实例所在的资源组 ID。
zoneCountInteger1实例的可用区个数。
protocolStringHTTP实例的访问协议。
zoneInfosArray可用区信息。
└zoneIdStringcn-hangzhou-i可用区 ID。
└statusStringNORMAL可用区状态。支持:ISOLATION(下线)、NORMAL(正常)。
instanceTypeStringlogstash实例类型。
initedBooleantrue实例是否已完成初始化。
configArray[]实例配置。
endpointListArray节点信息。
└hostString172.16.xx.xx节点的 IP 地址。
└portInteger9200节点的访问端口号。
└zoneIdStringcn-hangzhou-i节点所在的可用区 ID。
说明 └表示子参数。

返回示例

变更历史

变更时间变更内容概要操作
2022-12-16
删除请求参数ownerId
2022-09-26
删除请求参数body
2022-06-20
新增请求参数tags

相关示例