Latest revision as of 12:11, 18 September 2015

This operation will list Bandwidth monitoring details for a specific Server.

[edit] GET /accounts/{accountId}/flexcloud/servers/{id}/monitoring/bandwidth?scope=monitoringScope&startDate=startDate&endDate=endDate&period=monitoringPeriod&method=statisticsMethod

[edit] Parameters

accountId - string

The selected account Id.

id

The unique identifier of the server.

scope

The monitoring scope used. Possible values: receive and transmit.

startDate

Start date for monitoring details report in format yyyy-mm-dd.

endDate

End date for monitoring details report in format yyyy-mm-dd.

period

The time period in seconds used for data interval. Possible values: 3600(one hour) or 86400(one day).

method

Statistics method used. Possible values: avg,sum,min and max.

[edit] Date Format

All dates are interpreted and represented in UTC with ISO 8601 format

[edit] Result

[edit] JSON

 [
    {
       "count": 143, 
       "date": "2012-05-07 00:00:00", 
       "values": 344130.30069930002
    }, 
    {
       "count": 144, 
       "date": "2012-05-08 00:00:00", 
       "values": 658.34027777777999
    }
 ]

count - integer

The count of bandwidth operations for the period specified.

date - string

The date and time stamp for the period specified.

values - float

The sample value calculated depending on statistics method used.

[edit] Response Codes

Success

HTTP/1.1 200 OK

The request is accepted for processing.

Failure

HTTP/1.1 400 Bad Request

HTTP/1.1 401 Unauthorized - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

HTTP/1.1 404 Not Found - The resource does not exist.

[edit] Examples

Successfully get Bandwidth usage monitoring data

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 200 OK

Response Body:

 [
    {
       "count": 143, 
       "date": "2012-05-07 00:00:00", 
       "values": 344130.30069930002
    }, 
    {
       "count": 144, 
       "date": "2012-05-08 00:00:00", 
       "values": 658.34027777777999
    }, 
    {
       "count": 144, 
       "date": "2012-05-09 00:00:00", 
       "values": 2.1111111111111001
    }
 ]

Failure while trying to get Bandwidth usage monitoring data with a bad scope parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=fake-scope&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": "The bandwidth monitoring scope is not supported",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a bad date parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=fake-date&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": {
          "startDate": "Invalid date"
       },
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a bad period parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=fake-period&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": {
          "period": "\"fake-period\" is not a number"
       },
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a bad method parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=fake-method

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": "Invalid statistics_method",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a missing scope parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": "The bandwidth monitoring scope is missing",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a missing date parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": {
          "startDate": "Required"
       },
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a missing period parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": {
          "period": "Required"
       },
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data with a missing method parameter

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 400 Bad Request

Response Body:

 {
    "badRequest": {
       "message": "Bad request", 
       "code": 400, 
       "details": {
          "method": "Required"
       },
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to get Bandwidth usage monitoring data for a non-existent server

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{fake-server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 404 Not Found

Response Body:

 {
    "itemNotFound": {
       "message": "Resource not found", 
       "code": 404, 
       "details": "",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Unauthorized access

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded fake_authentication_string

Response Code:

HTTP/1.1 401 Unauthorized

Response Body:

    401 Unauthorized
    This server could not verify that you are authorized to
    access the document you requested.  Either you supplied the
    wrong credentials (e.g., bad password), or your browser
    does not understand how to supply the credentials required.

Failure while trying to pass invalid account number

GET http(s)://{api_server}/accounts/fake/flexcloud/servers/{server_name}/monitoring/bandwidth?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg

Response Code:

HTTP/1.1 404 Not Found

Response Body:

 {
    "itemNotFound" : {
       "message": "Resource not found", 
       "code": 404, 
       "details": "",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

[edit] Alternative URI /servers/{id}/monitoring/bandwidth

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

GET /servers/{id}/monitoring/bandwidth