- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
This api is similar to hostStats.get
except that the response is less verbose.
HTTP request
GET https://apigee.googleapis.com/v1/{name=organizations/*/optimizedHostStats/**}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The resource name for which the interactive query will be executed. Must be of the form Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
select |
Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count) |
timeUnit |
A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned. |
timeRange |
Required. Time interval for the interactive query. Time range is specified as start~end. E.g 04/15/2017 00:00~05/15/2017 23:59. |
filter |
Enables drill-down on specific dimension values. |
sort |
This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC. |
sortby |
Comma separated list of columns to sort the final result. |
limit |
This parameter is used to limit the number of result items. Default and the max value is 14400. |
offset |
Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'. |
topk |
Take 'top k' results from results, for example, to return the top 5 results 'topk=5'. |
tsAscending |
Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC. |
realtime |
Legacy field: not used anymore. |
tzo |
This parameters contains the timezone offset value. |
accuracy |
Legacy field: not used anymore. |
envgroupHostname |
Required. The hostname for which the interactive query will be executed. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of OptimizedStats
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform