GoogleApi.Apigee.V1.Api.Organizations.apigee_organizations_optimized_host_stats_get

You're seeing just the function apigee_organizations_optimized_host_stats_get, go back to GoogleApi.Apigee.V1.Api.Organizations module for more information.
Link to this function

apigee_organizations_optimized_host_stats_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

apigee_organizations_optimized_host_stats_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OptimizedStats.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

This api is similar to GetHostStats except that the response is less verbose.

Parameters

  • connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name for which the interactive query will be executed. Must be of the form organizations/{organization_id}/optimizedHostStats/{dimensions}. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below organizations/{org}/optimizedHostStats/apiproxy,request_verb
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :accuracy (type: String.t) - Legacy field: not used anymore.
    • :envgroupHostname (type: String.t) - Required. The hostname for which the interactive query will be executed.
    • :filter (type: String.t) - Enables drill-down on specific dimension values.
    • :limit (type: String.t) - This parameter is used to limit the number of result items. Default and the max value is 14400.
    • :offset (type: String.t) - Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.
    • :realtime (type: boolean()) - Legacy field: not used anymore.
    • :select (type: String.t) - Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
    • :sort (type: String.t) - This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
    • :sortby (type: String.t) - Comma separated list of columns to sort the final result.
    • :timeRange (type: String.t) - 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.
    • :timeUnit (type: String.t) - A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
    • :topk (type: String.t) - Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
    • :tsAscending (type: boolean()) - Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
    • :tzo (type: String.t) - This parameters contains the timezone offset value.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OptimizedStats{}} on success
  • {:error, info} on failure