(One intermediate revision by one user not shown) | |||
Line 1: | Line 1: | ||
The [[Server|server]] bandwidth command will return a list the bandwidth usage for a server for a specified period. When this command is run it may take a few minutes for it to finish. | The [[Server|server]] bandwidth command will return a list the bandwidth usage for a server for a specified period. When this command is run it may take a few minutes for it to finish. | ||
==Path== | ==Path== | ||
− | */server/bandwidth/{$ | + | */server/bandwidth/{$start}/{$end}/{$serverid} |
==Method== | ==Method== | ||
Line 13: | Line 13: | ||
==Required Data Parameters== | ==Required Data Parameters== | ||
− | |||
*{$start}: The start date and time of the bandwidth records to be retrieved (unix timestamp). | *{$start}: The start date and time of the bandwidth records to be retrieved (unix timestamp). | ||
*{$end}: The end date and time of the bandwidth records to be retrieved (unix timestamp). | *{$end}: The end date and time of the bandwidth records to be retrieved (unix timestamp). | ||
+ | *{$serverid}: The server ID that is returned when using the [[Server List|list]] command. | ||
==Optional Data Parameters== | ==Optional Data Parameters== | ||
Line 27: | Line 27: | ||
[intotal] => The total inbound bandwidth used for the specified start/end time. | [intotal] => The total inbound bandwidth used for the specified start/end time. | ||
[outtotal] => The total outbound bandwidth used for the specified start/end time. | [outtotal] => The total outbound bandwidth used for the specified start/end time. | ||
− | [dailyusage] => | + | [dailyusage] => array( |
− | [0] => | + | [0] => stdClass Object( |
[in] => Inbound bandwidth used on a specific date. | [in] => Inbound bandwidth used on a specific date. | ||
[out] => Outbound bandwidth used on a specific date. | [out] => Outbound bandwidth used on a specific date. |
The server bandwidth command will return a list the bandwidth usage for a server for a specified period. When this command is run it may take a few minutes for it to finish.
Contents |
stdClass Object( [success] => TRUE/FALSE [data] => stdClass Object( [intotal] => The total inbound bandwidth used for the specified start/end time. [outtotal] => The total outbound bandwidth used for the specified start/end time. [dailyusage] => array( [0] => stdClass Object( [in] => Inbound bandwidth used on a specific date. [out] => Outbound bandwidth used on a specific date. [timestamp] => The date the bandwidth usage was retrieved (unix timestamp). [date] => The date the bandwidth usage was retrieved (human readable). ) ) ) )