Package de.tsystems.mms.apm.performancesignature.dynatracesaas.rest.api

Interface TopologySmartscapeHostApi

public interface TopologySmartscapeHostApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<List<Host>>	getHosts(Long startTimestamp, Long endTimestamp, String relativeTime, List<String> tag, Boolean showMonitoringCandidates, List<String> entity)	Lists all available hosts in your environment You can narrow down the output by specifying filtering parameters of the request.
retrofit2.Call<Host>	getSingleHost(String meIdentifier)	Gets parameters of the specified host

Method Detail

getHosts

@Headers("Content-Type:application/json; charset=utf-8")
@GET("entity/infrastructure/hosts")
retrofit2.Call<List<Host>> getHosts(@Query("startTimestamp")
                                    Long startTimestamp,
                                    @Query("endTimestamp")
                                    Long endTimestamp,
                                    @Query("relativeTime")
                                    String relativeTime,
                                    @Query("tag")
                                    List<String> tag,
                                    @Query("showMonitoringCandidates")
                                    Boolean showMonitoringCandidates,
                                    @Query("entity")
                                    List<String> entity)

Lists all available hosts in your environment You can narrow down the output by specifying filtering parameters of the request.

Parameters:

startTimestamp - Start timestamp of the requested timeframe, in milliseconds (UTC). If not set, then 72 hours behind from now is used. (optional)

endTimestamp - Start timestamp of the requested timeframe, in milliseconds (UTC). If not set, then now is used. (optional)

relativeTime - Relative timeframe, back from now. (optional)

tag - Filters the resulting set of hosts by the specified tag. A host has to match ALL specified tags. (optional)

showMonitoringCandidates - Include/exclude monitoring canditate to the response. Monitoring candidates are network entities, which are detected but not monitored. (optional)

entity - Only return specified hosts. (optional)

Returns:

Call<List<Host>>

getSingleHost

@Headers("Content-Type:application/json; charset=utf-8")
@GET("entity/infrastructure/hosts/{meIdentifier}")
retrofit2.Call<Host> getSingleHost(@Path("meIdentifier")
                                   String meIdentifier)

Gets parameters of the specified host

Parameters:

meIdentifier - Dynatrace entity ID of the host you're inquiring. You can find it in the URL of the corresponding host page, for example, `HOST-007`. (required)

Returns:

Call<Host>