Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetQueryResultsWorkloadInsightsTopContributorsData

Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.

This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see GetQueryResultsWorkloadInsightsTopContributors.

Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData. Use the scope ID that was returned for your account by CreateScope.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

Request Syntax


GET /workloadInsights/scopeId/topContributorsDataQueries/queryId/results?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The number of query results that you want to return with this call.

nextToken

The token for the next set of results. You receive this token from a previous call.

queryId

The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

Required: Yes

scopeId

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datapoints": [ 
      { 
         "label": "string",
         "timestamps": [ "string" ],
         "values": [ number ]
      }
   ],
   "nextToken": "string",
   "unit": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

datapoints

The datapoints returned by the query.

Type: Array of WorkloadInsightsTopContributorsDataPoint objects

nextToken

The token for the next set of results. You receive this token from a previous call.

Type: String

unit

The units for a metric returned by the query.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The request specifies a resource that doesn't exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeded a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

Invalid request.

HTTP Status Code: 400