EdgeLoadBalancerAnalyticReport

A Load Balancer Analytic Report. It represents a timeseries of Edge Gateway Load Balancer runtime data.


Properties

string
componentId Optional

The virtual service or pool URN identifier.


data Optional

The metric timeseries of data for this report.


string
gatewayId Optional

The gateway URN identier.


string
metric Optional

The metric for this specific report. Supported metrics can be determined by using the supported metrics API.


statistics Optional

A statistical summary of the data in the report.


string
units Optional

The units for this specific report. Units may be one of the following

  • PER_SECOND
  • METRIC_COUNT
  • BITS_PER_SECOND
  • BYTES_PER_SECOND
  • MILLISECONDS
  • PERCENT
Units are derived from the reported metric.

JSON Example

{
	"componentId": "string",
	"data": [
		{
			"timestamp": "string",
			"value": "string"
		}
	],
	"gatewayId": "string",
	"metric": "string",
	"statistics": {
		"endTime": "string",
		"max": 0,
		"mean": 0,
		"min": 0,
		"sampleSize": 0,
		"startTime": "string",
		"trend": 0
	},
	"units": "string"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-cross-references:
- cross-reference:
    alias: metric
- cross-reference:
    alias: step
- cross-reference:
    alias: limit
- cross-reference:
    alias: startTime
- cross-reference:
    alias: endTime
- cross-reference:
    alias: componentId
x-vcloud-property-annotations:
  componentId:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSortable
  data:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  gatewayId:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  metric:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSortable
  statistics:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  units:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
Availability
Added in 35.0
Property Of

EdgeLoadBalancerAnalyticReports

Feedback

Was this page helpful?