Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 4.85 KB

StatisticsApi.md

File metadata and controls

112 lines (74 loc) · 4.85 KB
Raw

{{classname}}

All URIs are relative to https://api.equinix.com

Method HTTP request Description
GetConnectionStatsByPortUuid Get /fabric/v4/connections/{connectionId}/stats Get Stats by uuid
GetPortStats Get /fabric/v4/ports/stats Top Port Statistics
GetPortStatsByPortUuid Get /fabric/v4/ports/{portId}/stats Get Stats by uuid

GetConnectionStatsByPortUuid

Statistics GetConnectionStatsByPortUuid(ctx, connectionId, startDateTime, endDateTime, viewPoint) Get Stats by uuid

This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
connectionId string Connection UUID
startDateTime time.Time startDateTime
endDateTime time.Time endDateTime
viewPoint ViewPoint viewPoint

Return type

Statistics

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPortStats

TopUtilizedStatistics GetPortStats(ctx, metros, optional) Top Port Statistics

This API provides top utilized service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
metros []string Two-letter prefix indicating the metropolitan area in which a specified Equinix asset is located.
optional *StatisticsApiGetPortStatsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a StatisticsApiGetPortStatsOpts struct

Name Type Description Notes

sort | optional.Interface of Sort| Key or set of keys that organizes the search payload by property (such as createdDate or metroCode) or by direction. Ascending (ASC) is the default value. The "?" prefix indicates descending (DESC) order. | top | optional.Interface of int32| Filter returning only the specified number of most heavily trafficked ports. The standard value is [1...10], and the default is 5. | duration | optional.Interface of Duration| duration | direction | optional.Interface of QueryDirection| Direction of traffic from the requester's viewpoint. The default is outbound. | metricInterval | optional.Interface of MetricInterval| metricInterval | projectId | optional.Interface of string| projectId |

Return type

TopUtilizedStatistics

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPortStatsByPortUuid

Statistics GetPortStatsByPortUuid(ctx, portId, startDateTime, endDateTime) Get Stats by uuid

This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
portId string Port UUID
startDateTime time.Time startDateTime
endDateTime time.Time endDateTime

Return type

Statistics

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]