Get availability of a given resource

Retrieves the availability data of a specified resource within a given time range. This allows users to monitor and analyze the resource's uptime, downtime, unknowntime and undefinedtime over a specific period. The API returns detailed availability information such as the total uptime, downtime, and percentage of availability, providing insights into the performance and reliability of the resource.

Gets availability information for a specified resource over a defined time period.

Query Parameter:

Name Possible Values Resource
select up Yes
down Yes
unknown Yes
undefined Yes
degraded NA
all * - (Default) Yes

Example:

GET api/v3/tenants/{clientId}/resources/{resourceId}/availability?startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&select=all,up,down,unknown,undefined

Path Parameters

  • resourceIdstringrequired

    Resource uuid of the managed resource

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

  • totalTimeDurationinteger

    Total time duration in seconds for which the resource has been monitored.

  • upTimeDurationinteger

    Total duration in seconds for which the resource was in an 'up' state.

  • downTimeDurationinteger

    Total duration in seconds for which the resource was in a 'down' state.

  • unknownTimeDurationinteger

    Total duration in seconds for which the resource's state was 'unknown'.

  • undefinedTimeDurationinteger

    Total duration in seconds for which the resource's state was 'undefined'.

  • unplannedDownTimeDurationinteger

    Total duration in seconds for unplanned downtime of the resource.

  • upPercentagenumber

    Percentage of time the resource was in the 'up' state.

  • downPercentagenumber

    Percentage of time the resource was in the 'down' state.

  • unknownPercentagenumber

    Percentage of time the resource's state was 'unknown'.

  • undefinedPercentagenumber

    Percentage of time the resource's state was 'undefined'.

  • allLogListarray

    List of all state logs for the resource.

  • upTimeLogListarray

    List of logs when the resource was in the 'up' state.

  • downTimeLogListarray

    List of logs when the resource was in the 'down' state.

  • unknownTimeLogListarray

    List of logs when the resource was in the 'unknown' state.

  • undefinedTimeLogListarray

    List of logs when the resource was in the 'undefined' state.

Loading Examples...