host_stats
Creates, updates, deletes, gets or lists a host_stats resource.
Overview
| Name | host_stats |
| Type | Resource |
| Id | google.apigee.host_stats |
Fields
The following fields are returned by SELECT queries:
- organizations_host_stats_get
| Name | Datatype | Description |
|---|---|---|
environments | array | List of query results on the environment level. |
hosts | array | List of query results grouped by host. |
metaData | object | Metadata information. (id: GoogleCloudApigeeV1Metadata) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
organizations_host_stats_get | select | organizationsId, hostStatsId | offset, filter, tzo, sort, envgroupHostname, tsAscending, realtime, accuracy, select, timeRange, limit, topk, timeUnit, sortby | Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
hostStatsId | string | |
organizationsId | string | |
accuracy | string | |
envgroupHostname | string | |
filter | string | |
limit | string | |
offset | string | |
realtime | boolean | |
select | string | |
sort | string | |
sortby | string | |
timeRange | string | |
timeUnit | string | |
topk | string | |
tsAscending | boolean | |
tzo | string |
SELECT examples
- organizations_host_stats_get
Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
SELECT
environments,
hosts,
metaData
FROM google.apigee.host_stats
WHERE organizationsId = '{{ organizationsId }}' -- required
AND hostStatsId = '{{ hostStatsId }}' -- required
AND offset = '{{ offset }}'
AND filter = '{{ filter }}'
AND tzo = '{{ tzo }}'
AND sort = '{{ sort }}'
AND envgroupHostname = '{{ envgroupHostname }}'
AND tsAscending = '{{ tsAscending }}'
AND realtime = '{{ realtime }}'
AND accuracy = '{{ accuracy }}'
AND select = '{{ select }}'
AND timeRange = '{{ timeRange }}'
AND limit = '{{ limit }}'
AND topk = '{{ topk }}'
AND timeUnit = '{{ timeUnit }}'
AND sortby = '{{ sortby }}'
;