@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
49 lines (48 loc) • 2.72 kB
TypeScript
import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi";
import { Configuration } from "../../datadog-api-client-common/configuration";
import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
import { NetworkHealthInsightsResponse } from "../models/NetworkHealthInsightsResponse";
export declare class NetworkHealthInsightsApiRequestFactory extends BaseAPIRequestFactory {
listNetworkHealthInsights(from?: string, to?: string, _options?: Configuration): Promise<RequestContext>;
}
export declare class NetworkHealthInsightsApiResponseProcessor {
/**
* Unwraps the actual response sent by the server from the response context and deserializes the response content
* to the expected objects
*
* @params response Response returned by the server for a request to listNetworkHealthInsights
* @throws ApiException if the response code was not in [200, 299]
*/
listNetworkHealthInsights(response: ResponseContext): Promise<NetworkHealthInsightsResponse>;
}
export interface NetworkHealthInsightsApiListNetworkHealthInsightsRequest {
/**
* Unix timestamp (number of seconds since epoch) of the start of the query window.
* If not provided, the start of the query window will be 15 minutes before the `to` timestamp.
* If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
* @type string
*/
from?: string;
/**
* Unix timestamp (number of seconds since epoch) of the end of the query window.
* If not provided, the end of the query window will be the current time.
* If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
* @type string
*/
to?: string;
}
export declare class NetworkHealthInsightsApi {
private requestFactory;
private responseProcessor;
private configuration;
constructor(configuration: Configuration, requestFactory?: NetworkHealthInsightsApiRequestFactory, responseProcessor?: NetworkHealthInsightsApiResponseProcessor);
/**
* Return network health insights for the organization within the given time window.
* Insights are produced by analyzing DNS failures pre-classified by `network-dns-logger`,
* TLS certificate metrics, and denied security group connections. Each insight
* identifies the client and server services involved, the type of issue, and the
* magnitude of the failure observed during the query window.
* @param param The request object
*/
listNetworkHealthInsights(param?: NetworkHealthInsightsApiListNetworkHealthInsightsRequest, options?: Configuration): Promise<NetworkHealthInsightsResponse>;
}