How Can We Help?
This section describes the usage of Query APIs to get details on events raised for workload KPIs.
Details of Workload Events
To get details of time-series events raised on a service for workload KPIs, use the ‘workload-events’ Query API as follows:
API Name – workload-events
Format – GET /config/accounts/{accountId}/services/{serviceId}/workload-events
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | serviceId | ID or Identifier of a service | string | Mandatory |
| Query | from | Time Range in GMT format | string | Mandatory |
| Query | to | String | Mandatory |
Output Parameters
Output Type: CSV
- Request ID – Unique ID of a request
- Request Name – Name of a request
- Time – Timestamp in GMT at which KPI value is collected
- KPI ID – Unique ID of a workload KPI
- KPI Name – Name of a workload KPI
- Actual Value – Value of a workload KPI
- Unit – Unit of measurement for KPI value
- Operation – Relational Operator to check KPI value with respect to set threshold
- Lower Threshold – Lower value of threshold
- Upper Threshold – Upper value of threshold
- Signal Ids – Unique ID of a signal raised
- Forensics Configured Time – Time at which forensics was configured for an OOB or a custom KPI
- Forensic Collected – It is either yes or no. Yes indicates HEAL collected forensics for a KPI. No indicates that HEAL couldn’t collect the forensics.
Sample Input
http://<keycloak_host>:<keycloak_port>/appsone-query-api/v1.0/config/accounts/d681ef13-d690-4917-jkhg-6c79b-1/services/WAS-Servers/workload-events?from=2020-09-30 04:20:00&to=2020-09-30 10:31:00