Comment on page
Tag API
Contents
End Point:
GET /api/v1/tags
Curl examples:
curl -X GET "https://[email protected]/api/v1/tags"
Search for all the tag lists
Response format:
HTTP/1.1 200
Content-Type: application/json
["cluster", "host", "process", "service", "name"]
Status Codes:
- 200 - Success
End Point:
GET /api/v1/tags/findSeries?
GET /api/v1/tags/<tagname>?
Curl examples:
curl -X GET "https://[email protected]/api/v1/tags/findSeries?expr=cluster=prod"
curl -X GET "https://[email protected]/api/v1/tags/findSeries?expr=cluster=prod&host=egg-0001"
Search for tagged metric/series that match the expression
cluster=prodcurl -X GET "https://[email protected]/api/v1/tags/host?filter=prod-00*&limit=3"
Search for tagname
host that matches the value prod and only show 3 matching results.Available Parameters:
- expr Format:
expr=tagname=tagvalue or expr=tagname1=tagvalue1&tagname2=tagvalue2To search for the tagged series that match the expression, users should include both tagname and value in the query. - filter Format:
filter=prod-00*Tag value to search for. - limit Format:
limit=3To limit the number of search results to the given number.
Response format with ‘
?expr=cluster=prod’:HTTP/1.1 200
Content-Type: application/json
["0.queue_backlog;cluster=prod;host=prod-egg-0021;process=grind;service=data_process", "2.queue_backlog;cluster=prod;host=prod-egg-0021;process=grind;service=data_process", "0.items;cluster=prod;host=prod-egg-001;process=dump;service=data_process"]
Response format with ‘
?filter=machine-000*&limit=3’:HTTP/1.1 200
Content-Type: application/json
{"tag": "host",
"values": [{"count": 59, "value": "machine-0001"},
{"count": 57, "value": "machine-0002"},
{"count": 59, "value": "machine-0003"}]
}
Response Parameters:
- tag: Tag name.
- values: Tag value.
Status Codes:
- 200 - Success
- 400 - Invalid format
- 501 - Not Implemented
End Point:
POST /api/v1/tags/delSeries
Curl example:
curl -X POST "https://YOUR[email protected]/api/v1/tags/delSeries" --data-urlencode "path=foo.bar;tag1=val1;tag2=val2"
Delete all series that match the path foo.bar and tag1=val1 and tag2=val2.
Status Codes:
If you have sent tagged metrics then the number of tagged metrics you have sent will be displayed when you hover over the metric count on your Homepage:
Last modified 3mo ago