How Can We Help?
This section describes the usage of Query APIs to get information on component and host instances for services in HEAL.
Using ‘instances’ Query API, you can get details on the following:
- Host cluster instances
- Component cluster instances
- Host instances
- Component instances
Instance Details for a Service
To get details of all the instances mapped to a service for a specific account, use the ‘instances’ Query API as follows:
API Name – instances
Format – GET /config/accounts/{accountId}/services/{serviceId}/instances
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 | instanceType | It can be “cluster” or “all”. Default value is “instances”. In this case, instance level details are provided for the service. If “cluster” is specified, cluster level details are provided. If “all” is specified, both cluster and instance level details are provided. | string | Optional |
Output Parameters
Output Type: CSV
- Instance Id – Unique ID of an instance
- Instance Name – Name of an instance
- Host Address – IP address or domain name of an instance
- Component Name – Name of the component
- Component Version – Version of the component
Sample Input
Details of an Instance
To get details of an instance mapped to a service for a specific account, use the ‘instances’ Query API as follows:
API Name – instances
Format – GET /config/accounts/{accountId}/services/{serviceId}/instances/{instanceId}
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 |
| Path | instanceId | ID or Identifier of an Instance. You can also specify cluster id here. | string | Mandatory |
Output Parameters
Output Type: CSV
- Instance Id – Unique ID of an instance
- Instance Name – Name of an instance
- Host Address – IP address or domain name of an instance
- Component Name – Name of the component
- Component Version – Version of the component
Sample Input
Details of Component Instances
To get details of all the component instances for a specific account in HEAL, use the ‘componentInstances’ Query API as follows:
API Name – componentInstances
Format – GET /config/accounts/{accountId}/componentInstances
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Query | componentType | Type of a Component. It needs to be one of the following values: 1) “Application Server” 2) “Database Server” 3) “Host” 4) “Services” 5) “Web Server” | string | Mandatory |
| Query | instanceType | It can be “cluster” or “all”. Default value is “instances”. In this case, instance level details are provided for the component. If “cluster” is specified, cluster level details are provided. If “all” is specified, both cluster and instance level details are provided. | string | Optional |
Output Parameters
Output Type: CSV
- Instance Id – Unique ID of a component instance
- Instance Name – Name of a component instance
- Host Address – Host IP address on which component instance is running
- Component Sub-Type – Component Name as per the database
- Component Version – Version of the component
- Application Name – Name of an application in the account
Sample Input
Details of No Data Instances
To get details of all the instances having no KPIs details captured for an application in an account over a time period, use the ‘no-data-instances’ Query API as follows:
API Name – no-data-instances
Format – GET /config/accounts/{accountId}/applications/{applicationId}/no-data-instances
Input Parameters
| Type | Name | Description | Schema | Mandatory/ Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | applicationId | ID or Identifier of an Application | string | Mandatory |
| Query | from | Time Range in GMT format | string | Mandatory |
| Query | to | string | Mandatory |
Output Parameters
Output Type: CSV
- Instance Id – Id or Identifier of an instance. It can also be a cluster id.
- Instance Name – Name of an instance
- Host Address – IP address of the host
- Service Name – Name of a Service
Sample Input
Details of Maintenance Window
To get details of all the adhoc maintenance windows for an instance of a service in an account over a time period, use the ‘maintenance-data’ Query API as follows:
API Name – maintenance-data
Format – GET /config/accounts/{accountId}/instances/{instanceId}/maintenance-data
Input Parameters
| Type | Name | Description | Schema | Mandatory/ Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | instanceId | ID or Identifier of a host or a component instance | string | Mandatory |
| Query | from | Time Range in GMT format | string | Mandatory |
| Query | to | string | Mandatory |
Output Parameters
Output Type: – CSV
- Instance Id – Id or Identifier of a host or a component instance
- Instance Name – Name of an instance
- Host Address – IP address of the host
- From Time, To Time – Date and time for an ad-hoc maintenance window
- Duration – Adhoc Maintenance Window time duration in minutes
Sample Input