You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.
You are here: Web API Reference Guide > Available API Methods > Codetracing Methods > The codetracingList Method

The codetracingList Method

Retrieve a list of code-tracing files available for download using codetracingDownloadTraceFile.

 

Required Permissions: Full

HTTP method: GET

Supported Editions: Zend Server, Zend Server Cluster Manager

Request parameters:

Parameter

 Type

Required

Description

applications

Array

No

List of application IDs. If specified, code-tracing entries will be returned for these applications only. Default: all applications

limit

Integer

No

 

Row limit to retrieve, defaults to value defined in zend-user-user.ini

offset

Integer

No

 

The page offset to be displayed, defaults to 0

orderBy

String

No

 

Column to sort the result by (Id, Date, Url, CreatedBy, Filesize), defaults to Date

direction

String

No

 

Sorting direction , defaults to Desc

 

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: Response successful message or error message

Possible Action Specific Error Codes: This action has no specific error codes

 

Usage Example

Example:

Request:

GET /ZendServerManager/Api/codetracingIsEnabled

 

Response:

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.1">

    <requestData>

           <apiKeyName><![CDATA[Admin]]></apiKeyName>

           <method>codetracingIsEnabled</method>

    </requestData>

    <responseData>

           <codeTracingStatus>

               <componentStatus>Active</componentStatus>

               <alwaysDump>On</alwaysDump>

               <traceEnabled>On</traceEnabled>

               <awaitsRestart>1</awaitsRestart>

           </codeTracingStatus>

     </responseData>

<zendServerAPIResponse>

 

 

 

Related Links

Related Links:

Available API Methods

 

 

 

© 1999-2013 Zend Technologies, Ltd. All rights reserved.