You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.
You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.Retrieve a list of monitor issues according to a preset filter identifier. The filter identifier is shared with the UI's predefined filters. This WebAPI method may also accept ordering details and paging limits.
The response is a list of issue elements with their general details and event-groups identifiers.
Required Permissions: Read-only
HTTP method: GET
Supported by Editions: Zend Server, Zend Server Cluster Manager
Request Parameters:
|
Parameter |
Type |
Required |
Description |
|
filterId |
String |
Yes |
The predefined filter's id. Can be the filter's “name” or the actual identifier randomly created by the system. This parameter is case-sensitive |
|
limit |
Integer |
No |
The number of rows to retrieve. Default lists all events up to an arbitrary limit set by the system |
|
offset |
Integer
|
No
|
A paging offset to begin the issues list from. Default is 0 |
|
order |
String |
No
|
Column identifier for sorting the result set (id, repeats, date, eventType, fullUrl, severity, status). Default is date |
|
direction |
String |
No
|
Sorting direction: Ascending or Descending. Default is Descending |
Expected Response Code: 200 OK. For more information see Response Format.
Response Format: Response successful message or error message
Possible Action Specific Error Codes:
|
HTTP Code |
Error Code |
Description |
|
404 |
noSuchFilterId |
The requested filter does not exist |
|
|
Example:
Request: GET /ZendServerManager/Api/monitorIssuesListByPredefinedFilter?filterId=1&limit=20&offset=0&order=lastOccurance&direction=DESC Content-type: application/x-www-form-urlencoded
Response: <?xml version="1.0" encoding="UTF-8"?> <zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.1"> <requestData> <apiKeyName><![CDATA[Admin]]></apiKeyName> <method>monitorGetIssuesListByPredefinedFilter</method> </requestData> <responseData> <issues> <issue> <id>11</id> <rule>PHP Error</rule> <count>1</count> <lastOccurance>123412341234</lastOccurance> <severity>Warning</severity> <status>Open</status> <generalDetails> <url>http://localhost/test.php</url> <sourceFile>/var/www/test.php</sourceFile> <sourceLine>302</sourceLine> <function>fopen</function> <aggregationHint>123412341234</aggregationHint> <errorString>Permission Denied</errorString> <errorType>E_WARNING</errorType> </generalDetails> </issue> </issues> </responseData> </zendServerAPIResponse> |
|
|
|
|
|
|
|
|
Related Links: Available API Methods |
|
|
|
© 1999-2013 Zend Technologies, Ltd. All rights reserved.
