ServerMonitoringDetailsCPU - Revision history

Mike.robski: 1 revision: Release 87

2013-11-19T19:16:02Z

1 revision: Release 87

Donghyun.kim: /* Parameters */

2013-10-30T18:31:45Z

Parameters

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:55Z

1 revision: Release 86

Emanuela.mitreva at 14:50, 11 July 2013

2013-07-11T14:50:07Z

Show changes

Mike.robski: 1 revision

2013-05-24T15:24:59Z

1 revision

Mike.robski at 13:15, 20 May 2013

2013-05-20T13:15:28Z

Administrator at 01:21, 13 April 2013

2013-04-13T01:21:40Z

Mike.robski at 23:05, 14 December 2012

2012-12-14T23:05:16Z

Mike.robski at 20:36, 14 December 2012

2012-12-14T20:36:09Z

Administrator: Created page with "This operation will list CPU monitoring details for a specific Server. ='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=mo..."

2012-07-04T21:21:46Z

Created page with "This operation will list CPU monitoring details for a specific Server. ='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=mo..."

New page

This operation will list CPU monitoring details for a specific [[Server]].

='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''=

== Parameters ==
; id
: The unique identifier of the server.

; startDate
: Start date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; endDate
: End date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.

; 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'''.

== Result ==
=== JSON ===
[
{
"count": 144,
"date": "2012-05-07 00:00:00",
"values": 0.0
},
{
"count": 143,
"date": "2012-05-08 00:00:00",
"values": 0.0
}
]

; count - ''integer''
: The count of CPU 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.

== 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.

== Examples ==
'''Successfully get CPU usage monitoring data'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
[
{
"count": 144,
"date": "2012-05-07 00:00:00",
"values": 0.0
},
{
"count": 143,
"date": "2012-05-08 00:00:00",
"values": 0.0
},
{
"count": 144,
"date": "2012-05-09 00:00:00",
"values": 0.0
}
]

'''Failure while trying to get CPU usage monitoring data with a bad date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Invalid date"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a bad period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "\"fake-period\" is not a number"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a bad method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": "Invalid statistics_method"
}
}

'''Failure while trying to get CPU usage monitoring data with a missing date parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"startDate": "Required"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a missing period parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"period": "Required"
}
}
}

'''Failure while trying to get CPU usage monitoring data with a missing method parameter'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad request",
"code": 400,
"details": {
"method": "Required"
}
}
}

'''Failure while trying to get CPU usage monitoring data for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{fake-server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
}

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?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:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''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.



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

← Older revision		Revision as of 01:21, 13 April 2013
Line 1:		Line 1:
−	~~=='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''==~~
	This operation will list CPU monitoring details for a specific [[Server]].		This operation will list CPU monitoring details for a specific [[Server]].
		+
		+	=='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''==

	=== Parameters ===		=== Parameters ===

← Older revision		Revision as of 20:36, 14 December 2012
Line 251:		Line 251:
	does not understand how to supply the credentials required.		does not understand how to supply the credentials required.

		+
		+	[[Category:API]]

	<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->		<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->

@@ Line 11: / Line 11: @@
 ; startDate
-: Start date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.
+: Start date for monitoring details report in format '''yyyy-mm-dd'''.
 ; endDate
-: End date for monitoring details report in format '''yyyy-mm-dd hh:mm:ss'''.
+: End date for monitoring details report in format '''yyyy-mm-dd'''.
 ; period

@@ Line 1: / Line 1: @@
 This operation will list CPU monitoring details for a specific [[Server]].
-=='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''==
+='''GET''' /servers/'''id'''/monitoring/cpu?''startDate=startDate''&''endDate=endDate''&''period=monitoringPeriod''&''method=statisticsMethod'''''=
-=== Parameters ===
+== Parameters ==
 ; id
 : The unique identifier of the server.
@@ Line 19: / Line 19: @@
 : Statistics method used.  Possible values: '''avg''','''sum''','''min''' and '''max'''.
-=== Result ===
+== Result ==
-==== JSON ====
+=== JSON ===
+  [
+     {
@@ Line 43: / Line 43: @@
 : The sample value calculated depending on statistics method used.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 :''HTTP/1.1 200 OK''
@@ Line 52: / Line 52: @@
 :''HTTP/1.1 404 Not Found'' - The resource does not exist.
-=== Examples ===
+== Examples ==
 '''Successfully get CPU usage monitoring data'''
 :'''GET''' http(s)://{api_server}/servers/{server_name}/monitoring/cpu?startDate=2012-05-07&endDate=2012-05-10&period=86400&method=avg
@@ Line 101: / Line 101: @@
         "details": {
            "startDate": "Invalid date"
+        },
+     }
+  }
@@ Line 123: / Line 124: @@
         "details": {
            "period": "\"fake-period\" is not a number"
+        },
+     }
+  }
@@ Line 143: / Line 145: @@
         "message": "Bad request",
         "code": 400,
-        "details": "Invalid statistics_method"
+        "details": "Invalid statistics_method",
+     }
+  }
@@ Line 165: / Line 168: @@
         "details": {
            "startDate": "Required"
+        },
+     }
+  }
@@ Line 187: / Line 191: @@
         "details": {
            "period": "Required"
+        },
+     }
+  }
@@ Line 209: / Line 214: @@
         "details": {
            "method": "Required"
+        },
+     }
+  }
@@ Line 229: / Line 235: @@
         "message": "Resource not found",
         "code": 404,
-        "details": ""
+        "details": "",
+     }
+  }
@@ Line 253: / Line 260: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]