cat datafeeds API
编辑cat datafeeds API
编辑cat API 仅供人类通过命令行或 Kibana 控制台使用。不 适合应用程序使用。对于应用程序使用,请使用 获取数据源统计信息 API。
返回有关数据源的配置和使用信息。
先决条件
编辑路径参数
编辑-
<feed_id>
- (可选,字符串)唯一标识数据源的数字字符串。此标识符可以包含小写字母数字字符(a-z 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。
查询参数
编辑-
allow_no_match
-
(可选,布尔值)指定当请求
- 包含通配符表达式且没有匹配的数据源时该怎么做。
- 包含
_all
字符串或没有标识符且没有匹配项时该怎么做。 - 包含通配符表达式且只有部分匹配项时该怎么做。
默认值为
true
,当没有匹配项时返回一个空的datafeeds
数组,当有部分匹配项时返回结果子集。如果此参数为false
,则当没有匹配项或只有部分匹配项时,请求将返回404
状态代码。 -
format
- (可选,字符串)HTTP accept header 的简短版本。有效值包括 JSON、YAML 等。
-
h
-
(可选,字符串)要显示的列名称的逗号分隔列表。
如果您不指定要包含的列,则 API 返回默认列。如果您明确指定一个或多个列,则它仅返回指定的列。
有效列包括
-
assignment_explanation
,ae
- 仅对于已启动的数据源,包含与选择节点相关的消息。
-
buckets.count
,bc
,bucketsCount
- (默认)已处理的存储桶数。
-
id
- (默认)唯一标识数据源的数字字符串。此标识符可以包含小写字母数字字符(a-z 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。
-
node.address
,na
,nodeAddress
-
节点的网络地址。
仅对于已启动的数据源,此信息与数据源启动所在的节点有关。
-
node.ephemeral_id
,ne
,nodeEphemeralId
-
节点的临时 ID。
仅对于已启动的数据源,此信息与数据源启动所在的节点有关。
-
node.id
,ni
,nodeId
-
节点的唯一标识符。
仅对于已启动的数据源,此信息与数据源启动所在的节点有关。
-
node.name
,nn
,nodeName
-
节点名称。
仅对于已启动的数据源,此信息与数据源启动所在的节点有关。
-
search.bucket_avg
,sba
,searchBucketAvg
- 每个存储桶的平均搜索时间,以毫秒为单位。
-
search.count
,sc
,searchCount
- (默认)数据源运行的搜索次数。
-
search.exp_avg_hour
,seah
,searchExpAvgHour
- 每小时的指数平均搜索时间,以毫秒为单位。
-
search.time
,st
,searchTime
- 数据源花费在搜索上的总时间,以毫秒为单位。
-
state
,s
-
(默认)数据源的状态,可以是以下值之一
-
starting
:已请求启动数据源,但尚未启动。 -
started
:数据源正在主动接收数据。 -
stopping
:已请求数据源正常停止,并且正在完成其最终操作。 -
stopped
:数据源已停止,并且在重新启动之前不会接收数据。
-
-
-
help
- (可选,布尔值)如果为
true
,则响应包括帮助信息。默认为false
。 -
s
- (可选,字符串)用于对响应进行排序的列名称或列别名的逗号分隔列表。
-
time
- (可选,时间单位)用于显示时间值的单位。
-
v
- (可选,布尔值)如果为
true
,则响应包括列标题。默认为false
。
示例
编辑resp = client.cat.ml_datafeeds( v=True, ) print(resp)
response = client.cat.ml_datafeeds( v: true ) puts response
const response = await client.cat.mlDatafeeds({ v: "true", }); console.log(response);
GET _cat/ml/datafeeds?v=true
id state buckets.count search.count datafeed-high_sum_total_sales stopped 743 7 datafeed-low_request_rate stopped 1457 3 datafeed-response_code_rates stopped 1460 18 datafeed-url_scanning stopped 1460 18