List switch port bandwidth
This API is used to get bandwidth list of switch port.
1. Request Definition
- API URL:
https://bms-api.swiftfederation.com/v1.0/switch/port/bandwidth
- Request Method:
POST
- Request Header:
Refer to HTTP Request Headers
- Request Body:
Request Body Data Format: JSON
| Field | Required | Type | Description |
|---|---|---|---|
| switchName | Mandatory | string | Switch Name. |
| portName | Mandatory | string | Port name. |
| startTime | Mandatory | string | Start time. Format yyyy-MM-ddTHH:mm:ssZ UTC time. |
| endTime | Mandatory | string | End time. Format yyyy-MM-ddTHH:mm:ssZ UTC time. Interval between start time and end time cannot be longer than 24 hours. |
- Request Body Example
POST /v1.0/switch/port/bandwidth HTTP/1.1
Host: bms-api.swiftfederation.com
Authorization:HMAC-SHA256 a22sdsfgd1ds7dd13ds3:bc051d2e520a462e36455dc75b2bc68e9a135bbf4d2fefbf6d2fc1f28c5aa5dc
Content-Type:application/json; charset=utf-8
X-SFD-Date:20230605T131000Z
X-SFD-Nonce:69527
{"switchName":"JKT-DC6-SW01","portName":"Eth-Trunk1","startTime":"2023-06-05T17:35:00Z","endTime":"2023-06-05T17:45:00Z"}
2. Response Definition
- Response Header
Refer to HTTP Response Headers
- Response Body
| Field | Type | Description |
|---|---|---|
| switchName | string | Name of hostname. |
| portName | string | Port name. |
| bandwidth | List | bandwidth. |
| bandwidth Definition | ||
| inBandwidth | Number | In bandwidth (bps) |
| outBandwidth | Number | Out bandwidth (bps). |
| timestamp | string | Timestamp. Format yyyy-MM-ddTHH:mm:ssZ UTC time |
- Response Body Example
[{
"switchName": "JKT-DC6-SW01",
"portName": "Eth-Trunk1",
"bandwidth": [{
"in": 19750500000.00,
"outBandwidth": 76632150.00,
"timestamp": "2023-06-05T17:35:00Z"
},
{
"inBandwidth": 46492875000.00,
"outBandwidth": 43388400.00,
"timestamp": "2023-06-05T17:40:00Z"
}
]
}
]