Web API Reference Guide > Available API Methods > Page Cache Methods > The pagecacheRuleInfo Method

The pagecacheRuleInfo Method

Retrieve and display a page cache rule information.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

id

integer

Yes

Rule ID

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

Response Format: A page cache rule information.

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

500

internalServerError

Retrieving the rule failed due to an internal problem

Example

Usage Example

Request

GET /ZendServerManager/Api/pagecacheRuleInfo

Response

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

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

<requestData>

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

<method>pagecacheRuleInfo</method>

</requestData>

<responseData>

<ruleInfo>

<rule>

<id>1</id>

<urlScheme>http</urlScheme>

<urlHost>localhost</urlHost>

<urlPath>index.php</urlPath>

<type>exact_match</type>

<application></application>

<applicationId>-1</applicationId>

<name></name>

</rule>

<ruleData>

<ruleId>41</ruleId>

<conditionsType>and</conditionsType>

<conditions></conditions>

<splitby></splitby>

<lifetime>360</lifetime>

<compress>yes</compress>

</ruleData>

</ruleInfo>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Page Cache Methods