OBJECT

NetworkQuery

Represents the top level query node for network GraphQL queries.

link GraphQL Schema definition

  • type NetworkQuery {
  • # Query count of flows for a given flow type and entity type combination between
  • # startTime and endTime
  • # If startTime an endTime are not provided, it defaults to last 24 hours.
  • # This query response has fields which return multiple pages of data since it
  • # would analyze all flow records and bucket them based on
  • # the source or destination.
  • # This API conforms to the GraphQL relay pattern. The `pageInfo` can be used in
  • # combination with the
  • # `after` field to fetch the next page of records
  • # TODO this does not comply with GraphQL relay. The FlowTypeDetailsForEntityType
  • # should be a connection, or
  • # each subfield should take first,after parameters. There are ways of making this
  • # relay compatible. Please sync with Nick.
  • #
  • # Arguments
  • # after: [Not documented]
  • # first: the 'first' parameter is present for relay compatibility
  • # but its value is currently ignored
  • # input: [Not documented]
  • queryFlowTypeCountForEntityType(
  • after: String,
  • first: Int,
  • input: NetworkEntityFlowTypeInput!
  • ): NetworkFlowTypeDetailsForEntityType
  • # Query hybrid connectivity mechanism for a given entityId
  • #
  • # Arguments
  • # endTime: [Not documented]
  • # entityId: [Not documented]
  • # startTime: [Not documented]
  • queryHybridConnectivityUtilization(
  • endTime: DateTime,
  • entityId: EntityId!,
  • startTime: DateTime
  • ): NetworkHybridConnectivityUtilizationSummary
  • # Query the grouped network communications to/from a given entityId in a time
  • # range.
  • # If both startTime and endTime are not provided, it defaults to last 24 hours.
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # endTime: endTime for network flows. It defaults to now if
  • # startTime is not set, otherwise 24 hours after startTime
  • # entityId: Entity for which results are being queried
  • # flowMetrics: request specific flow metrics
  • # groupBy: Group flows by the given enumerated type
  • # outerGroupBy: Aggregate grouped flows by an outer level of
  • # grouping
  • # startTime: startTime for network flows. It defaults to 24 hours
  • # before endTime
  • queryNetworkCommunications(
  • endTime: DateTime,
  • entityId: EntityId!,
  • flowMetrics: [NetworkFlowMetricName!],
  • groupBy: NetworkCommunicationAggregation,
  • outerGroupBy: NetworkCommunicationAggregation,
  • startTime: DateTime
  • ): NetworkCommunicationSummaryList
  • # Query communication pattern for the given entityId
  • #
  • # Arguments
  • # endTime: [Not documented]
  • # entityId: [Not documented]
  • # startTime: [Not documented]
  • queryNetworkFlowSummary(
  • endTime: DateTime,
  • entityId: EntityId!,
  • startTime: DateTime
  • ): NetworkFlowSummary
  • # Query network overview for the given entityId between startTime and endTime
  • # If startTime and endTime are not provided, it defaults to last 24 hours
  • #
  • # Arguments
  • # endTime: [Not documented]
  • # entityId: [Not documented]
  • # startTime: [Not documented]
  • queryNetworkOverview(
  • endTime: DateTime,
  • entityId: EntityId!,
  • startTime: DateTime
  • ): NetworkOverview
  • # Query the network services of a given entityId in a time range.
  • # If both startTime and endTime are not provided, it defaults to last 24 hours.
  • #
  • # Arguments
  • # endTime: endTime for network flows. It defaults to now if
  • # startTime is not set, otherwise 24 hours after startTime
  • # entityId: Entity for which results are being queried
  • # flowMetrics: request specific flow metrics
  • # namespaceEntityId: List of Namespace Entity associated with the
  • # space
  • # startTime: startTime for network flows. It defaults to 24 hours
  • # before endTime
  • queryNetworkServiceDetails(
  • endTime: DateTime,
  • entityId: EntityId!,
  • flowMetrics: [NetworkFlowMetricName!],
  • namespaceEntityId: [EntityId],
  • startTime: DateTime
  • ): [NetworkService!]
  • # Query the network service stats in given service entityId in a time range and
  • # return the
  • # time-series values.
  • #
  • # Arguments
  • # endTime: endTime for network flows. It defaults to now if
  • # startTime is not set, otherwise 24 hours after startTime
  • # entityId: Entity for which results are being queried
  • # flowMetrics: request specific flow metrics
  • # intervalSeconds: the interval/buckets duration in seconds
  • # startTime: startTime for network flows. It defaults to 24 hours
  • # before endTime
  • queryNetworkServiceStats(
  • endTime: DateTime,
  • entityId: EntityId!,
  • flowMetrics: [NetworkFlowMetricName!],
  • intervalSeconds: Int,
  • startTime: DateTime
  • ): NetworkStatsService!
  • }

link Require by