/api/suggest
该端点提供了一种实现“自动完成”调用的方法,当用户在 GUI 中键入请求时,该调用可以重复访问。它不提供全文本搜索或通配符,而只是将查询中传递的整个字符串与存储数据的第一个字符进行匹配。例如,传递查询type=metrics&q=sys
将返回系统中以sys
开头的前 25 个 Metrics。匹配区分大小写,因此sys
将不匹配System.CPU
。结果按字母 Sequences 排序。
Verbs
-
GET
-
POST
Requests
Name | Data Type | Required | Description | Default | QS | RW | Example |
---|---|---|---|---|---|---|---|
type | String | Required | 自动完成的数据类型。必须是以下之一: metrics , tagk 或 tagv | type | metrics | ||
q | String | Optional | 匹配给定类型的字符串 | q | web | ||
max | Integer | Optional | 建议返回的最大结果数。必须大于 0 | 25 | max | 10 |
Example Request
Query String
http://localhost:4242/api/suggest?type=metrics&q=sys&max=10
JSON Content
{
"type":"metrics",
"q":"sys",
"max":10
}
Response
响应是与查询匹配的给定类型的字符串数组。如果找不到与查询匹配的内容,则将返回一个空数组。
Example Response
[
"sys.cpu.0.nice",
"sys.cpu.0.system",
"sys.cpu.0.user",
"sys.cpu.1.nice",
"sys.cpu.1.system",
"sys.cpu.1.user"
]