ServerMonitoringDetailsDisk
(Created page with "This operation will list Disk monitoring details for a specific Server. ='''GET''' /servers/'''id'''/monitoring/disk?''scope=monitoringScope''&''startDate=startDate''&''e...") |
Mike.robski (Talk | contribs) m (1 revision: Release 87) |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
This operation will list Disk monitoring details for a specific [[Server]]. | This operation will list Disk monitoring details for a specific [[Server]]. | ||
− | ='''GET''' / | + | ='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/monitoring/disk?''scope=monitoringScope''&''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''= |
== Parameters == | == Parameters == | ||
+ | ; accountId - ''string'' | ||
+ | : The selected account Id | ||
+ | |||
; id | ; id | ||
: The unique identifier of the server. | : The unique identifier of the server. | ||
Line 11: | Line 14: | ||
; startDate | ; startDate | ||
− | : Start date for monitoring details report in format '''yyyy-mm-dd | + | : Start date for monitoring details report in format '''yyyy-mm-dd'''. |
; endDate | ; endDate | ||
− | : End date for monitoring details report in format '''yyyy-mm-dd | + | : End date for monitoring details report in format '''yyyy-mm-dd'''. |
; period | ; period | ||
Line 24: | Line 27: | ||
== Result == | == Result == | ||
=== JSON === | === JSON === | ||
+ | <nowiki> | ||
[ | [ | ||
{ | { | ||
Line 35: | Line 39: | ||
"values": 6.0 | "values": 6.0 | ||
} | } | ||
− | ] | + | ]</nowiki> |
; count - ''integer'' | ; count - ''integer'' | ||
Line 57: | Line 61: | ||
== Examples == | == Examples == | ||
'''Successfully get Disk usage monitoring data''' | '''Successfully get Disk usage monitoring data''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 68: | Line 72: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
[ | [ | ||
{ | { | ||
Line 84: | Line 89: | ||
"values": 6.0 | "values": 6.0 | ||
} | } | ||
− | ] | + | ]</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a bad scope parameter''' | '''Failure while trying to get Disk usage monitoring data with a bad scope parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=<span style="color:red">fake-scope</span>&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=<span style="color:red">fake-scope</span>&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 98: | Line 103: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
"message": "Bad request", | "message": "Bad request", | ||
"code": 400, | "code": 400, | ||
− | "details": "The disk monitoring scope is not supported" | + | "details": "The disk monitoring scope is not supported", |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a bad date parameter''' | '''Failure while trying to get Disk usage monitoring data with a bad date parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=<span style="color:red">fake-date</span>&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=<span style="color:red">fake-date</span>&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 118: | Line 125: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
Line 124: | Line 132: | ||
"details": { | "details": { | ||
"startDate": "Invalid date" | "startDate": "Invalid date" | ||
− | } | + | }, |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a bad period parameter''' | '''Failure while trying to get Disk usage monitoring data with a bad period parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=<span style="color:red">fake-period</span>&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=<span style="color:red">fake-period</span>&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 140: | Line 149: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
Line 146: | Line 156: | ||
"details": { | "details": { | ||
"period": "\"fake-period\" is not a number" | "period": "\"fake-period\" is not a number" | ||
− | } | + | }, |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a bad method parameter''' | '''Failure while trying to get Disk usage monitoring data with a bad method parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=<span style="color:red">fake-method</span> | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=<span style="color:red">fake-method</span> |
''Request Headers:'' | ''Request Headers:'' | ||
Line 162: | Line 173: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
"message": "Bad request", | "message": "Bad request", | ||
"code": 400, | "code": 400, | ||
− | "details": "Invalid statistics_method" | + | "details": "Invalid statistics_method", |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a missing scope parameter''' | '''Failure while trying to get Disk usage monitoring data with a missing scope parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 182: | Line 195: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
"message": "Bad request", | "message": "Bad request", | ||
"code": 400, | "code": 400, | ||
− | "details": "The disk monitoring scope is missing" | + | "details": "The disk monitoring scope is missing", |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a missing date parameter''' | '''Failure while trying to get Disk usage monitoring data with a missing date parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 202: | Line 217: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
Line 208: | Line 224: | ||
"details": { | "details": { | ||
"startDate": "Required" | "startDate": "Required" | ||
− | } | + | }, |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a missing period parameter''' | '''Failure while trying to get Disk usage monitoring data with a missing period parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 224: | Line 241: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
Line 230: | Line 248: | ||
"details": { | "details": { | ||
"period": "Required" | "period": "Required" | ||
− | } | + | }, |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get Disk usage monitoring data with a missing method parameter''' | '''Failure while trying to get Disk usage monitoring data with a missing method parameter''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400 | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400 |
''Request Headers:'' | ''Request Headers:'' | ||
Line 246: | Line 265: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"badRequest": { | "badRequest": { | ||
Line 252: | Line 272: | ||
"details": { | "details": { | ||
"method": "Required" | "method": "Required" | ||
− | } | + | }, |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Failure while trying to get disk usage monitoring data for a non-existent server''' | '''Failure while trying to get disk usage monitoring data for a non-existent server''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{<span style="color:red">fake-server_name</span>}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{<span style="color:red">fake-server_name</span>}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 268: | Line 289: | ||
''Response Body:'' | ''Response Body:'' | ||
+ | <nowiki> | ||
{ | { | ||
"itemNotFound": { | "itemNotFound": { | ||
"message": "Resource not found", | "message": "Resource not found", | ||
"code": 404, | "code": 404, | ||
− | "details": "" | + | "details": "", |
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
} | } | ||
− | } | + | }</nowiki> |
'''Unauthorized access''' | '''Unauthorized access''' | ||
− | :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg | + | :'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg |
''Request Headers:'' | ''Request Headers:'' | ||
Line 294: | Line 317: | ||
does not understand how to supply the credentials required. | 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/disk?scope=usage&startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg | ||
+ | |||
+ | ''Response Code:'' | ||
+ | <pre>HTTP/1.1 404 Not Found</pre> | ||
+ | |||
+ | ''Response Body:'' | ||
+ | <nowiki> | ||
+ | { | ||
+ | "itemNotFound" : { | ||
+ | "message": "Resource not found", | ||
+ | "code": 404, | ||
+ | "details": "", | ||
+ | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
+ | } | ||
+ | }</nowiki> | ||
− | + | == Alternative URI /servers/{id}/monitoring/disk == | |
+ | 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 [[Authentication|authorization header]]. | ||
− | { | + | <code>GET /servers/{id}/monitoring/disk</code> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | [[Category:Hostway API]] | |
+ | [[Category:FlexCloud Server API]] |
Latest revision as of 13:16, 19 November 2013
This operation will list Disk monitoring details for a specific Server.
Contents |
[edit] GET /accounts/{accountId}/flexcloud/servers/{id}/monitoring/disk?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: usage, read_count, write_count, read_bytes and write_bytes.
- 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] Result
[edit] JSON
[ { "count": 144, "date": "2012-05-07 00:00:00", "values": 3.2083333333333002 }, { "count": 143, "date": "2012-05-08 00:00:00", "values": 6.0 } ]
- count - integer
- The count of disk 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 Disk usage monitoring data
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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": 144, "date": "2012-05-07 00:00:00", "values": 3.2083333333333002 }, { "count": 143, "date": "2012-05-08 00:00:00", "values": 6.0 }, { "count": 144, "date": "2012-05-09 00:00:00", "values": 6.0 } ]
Failure while trying to get Disk usage monitoring data with a bad scope parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 disk monitoring scope is not supported", "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" } }
Failure while trying to get Disk usage monitoring data with a bad date parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 Disk usage monitoring data with a bad period parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 Disk usage monitoring data with a bad method parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 Disk usage monitoring data with a missing scope parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 disk monitoring scope is missing", "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" } }
Failure while trying to get Disk usage monitoring data with a missing date parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 Disk usage monitoring data with a missing period parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 Disk usage monitoring data with a missing method parameter
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_name}/monitoring/disk?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 disk usage monitoring data for a non-existent server
- GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{fake-server_name}/monitoring/disk?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/disk?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/disk?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/disk
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/disk