Skip to main content

host_stats

Creates, updates, deletes, gets or lists a host_stats resource.

Overview

Namehost_stats
TypeResource
Idgoogle.apigee.host_stats

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
environmentsarrayList of query results on the environment level.
hostsarrayList of query results grouped by host.
metaDataobjectMetadata information. (id: GoogleCloudApigeeV1Metadata)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_host_stats_getselectorganizationsId, hostStatsIdselect, timeUnit, timeRange, filter, sort, sortby, limit, offset, topk, tsAscending, realtime, tzo, accuracy, envgroupHostnameRetrieve 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.

NameDatatypeDescription
hostStatsIdstring
organizationsIdstring
accuracystring
envgroupHostnamestring
filterstring
limitstring
offsetstring
realtimeboolean
selectstring
sortstring
sortbystring
timeRangestring
timeUnitstring
topkstring
tsAscendingboolean
tzostring

SELECT examples

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 select = '{{ select }}'
AND timeUnit = '{{ timeUnit }}'
AND timeRange = '{{ timeRange }}'
AND filter = '{{ filter }}'
AND sort = '{{ sort }}'
AND sortby = '{{ sortby }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND topk = '{{ topk }}'
AND tsAscending = '{{ tsAscending }}'
AND realtime = '{{ realtime }}'
AND tzo = '{{ tzo }}'
AND accuracy = '{{ accuracy }}'
AND envgroupHostname = '{{ envgroupHostname }}';