HTTP REST Api endpoint search lookup - IBM/ibm-spectrum-scale-bridge-for-grafana GitHub Wiki
-
/api/search/lookup
- Supported for OpenTSDB API
- This endpoint provides a basic means of searching for metadata
- Lookup queries are used to determine which time series are associated with a specific metric, tag name, tag value, tag pair or combination thereof. A lookup query consists of at least one metric, tag name (tagk) or tag value (tagv). Only one metric can be supplied per query but multiple tagk, tagv or tag pairs may be provided.
OpenTSDB API
Example output:
```console
# curl http://10.88.3.50:4242/api/search/lookup?m=gpfs_fs_disks -u scale_admin:TXlWZXJ5U3Ryb25nUGFzc3cwcmQhCg==
{"type": "LOOKUP", "metric": "gpfs_fs_disks", "tags": [], "results": [{"tags": {"node": "scale-11", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-11", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-11", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-12", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-12", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-12", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-12", "gpfs_cluster_name": "scale-cluster-2.vmlocal", "gpfs_fs_name": "remoteFS"}}, {"tags": {"node": "scale-13", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-13", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-13", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-13", "gpfs_cluster_name": "scale-cluster-2.vmlocal", "gpfs_fs_name": "remoteFS"}}, {"tags": {"node": "scale-14", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-14", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-14", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-14", "gpfs_cluster_name": "scale-cluster-2.vmlocal", "gpfs_fs_name": "remoteFS"}}, {"tags": {"node": "scale-15", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-15", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-15", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-15", "gpfs_cluster_name": "scale-cluster-2.vmlocal", "gpfs_fs_name": "remoteFS"}}, {"tags": {"node": "scale-16", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-16", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-16", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-16", "gpfs_cluster_name": "scale-cluster-2.vmlocal", "gpfs_fs_name": "remoteFS"}}, {"tags": {"node": "scale-17", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "afmCacheFS"}}, {"tags": {"node": "scale-17", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "cesSharedRoot"}}, {"tags": {"node": "scale-17", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-17", "gpfs_cluster_name": "scale-cluster-2.vmlocal", "gpfs_fs_name": "remoteFS"}}]}
```
Example output:
```console
# curl http://10.88.3.50:4242/api/search/lookup?m=gpfs_fs_disks%7Bgpfs_fs_name=localFS%7D -u scale_admin:TXlWZXJ5U3Ryb25nUGFzc3cwcmQhCg==
{"type": "LOOKUP", "metric": "gpfs_fs_disks", "tags": [{"key": "gpfs_fs_name", "value": "localFS"}], "results": [{"tags": {"node": "scale-11", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-12", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-13", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-14", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-15", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-16", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}, {"tags": {"node": "scale-17", "gpfs_cluster_name": "scale-cluster-1.vmlocal", "gpfs_fs_name": "localFS"}}]}
```