get
BandwidthUtilization-serviceId-get
The Utilization API enables you to view peak utilization and through-put on Secure Cloud Interconnect connections directly from your own portal without having to log into the Verizon Enterprise Center. This data could be utilized to identify applications driving peak traffic and monitor the actual spikes in traffic. The data will be published in megabits per second of data which are passed over a Secure Cloud Interconnect connection at 15 minute intervals. Both ingress and egress traffic can be viewed, and the data is refreshed every hour. You are required to provide the Billing Account Number (BAN) ID. You have the option to enter a start date and end date in the month. The start and end dates are restricted to the 30/31 days in the month selected. If a start and end date are not provided, the data will be automatically pulled for the entire month. You will see usage detail for each Service ID under that BAN for the specified date range.
Resource URL
| Environment | URL |
|---|---|
| Production |
https://digitalconnectproxy.verizon.com:443/sci /BandwidthUtilization/{serviceId} |
| Test |
https://https://digitalconnectproxy.verizon.com:443/sci /BandwidthUtilization/{serviceId} |
Query Parameters
| Name | Values | Description |
|---|---|---|
|
startDay
(optional) |
A number between 1 - 31.Note :Cannot exceed current day of the month. |
|
|
endDay
(optional) |
A number between 1 - 31.Note : endDay should be >= startDay and cannot exceed current day of the month. |
Request Body Parameters
| Attribute Name | Type | Description |
|---|---|---|
| utilizationMeta(Json) | ||
| timestamp | string | This is the current response time stamp of the utlization data. It will be in " DD-MON-YY HH:MM:SS " format. |
| cloudType | string | Type of Cloud. Eg : VPC , Dedicated VPC, Public. |
| serviceId | string | Service Instance Id of the SCI Connection |
| status | string | Status of the request ( success of failure ) |
| location | string | Location of Cloud Service Provider. |
| cloudProvider | string | Cloud Service Provider Name |
| utilizationData(Json Array) | ||
| time | string | Time Stamp of the utlization data. It will be in " DD-MON-YY HH:MM:SS " format. |
| recivedInkbps | string | No of bytes received from CSP in Kbps. |
| transmittedInkbps | string | No of bytes transmitted to CSP in Kbps. |
Response Body Parameters
| Attribute Name | Type | Description |
|---|---|---|
| utilizationMeta(Json) | ||
| timestamp | string | This is the current response time stamp of the utlization data. It will be in " DD-MON-YY HH:MM:SS " format. |
| cloudType | string | Type of Cloud. Eg : VPC , Dedicated VPC, Public. |
| serviceId | string | Service Instance Id of the SCI Connection |
| status | string | Status of the request ( success of failure ) |
| location | string | Location of Cloud Service Provider. |
| cloudProvider | string | Cloud Service Provider Name |
| utilizationData(Json Array) | ||
| time | string | Time Stamp of the utlization data. It will be in " DD-MON-YY HH:MM:SS " format. |
| recivedInkbps | string | No of bytes received from CSP in Kbps. |
| transmittedInkbps | string | No of bytes transmitted to CSP in Kbps. |
Body Parameters
Sample Request
serviceId PQ Service Instance Id true
Please login to send the sample request and get a reponse back.
Working...