Use the get-limit-descriptor operation to retrieve descriptor of subscription limits. For details on descriptors, refer to the Representation of Object Descriptor section. For details on limits of a subscription, refer to the Limits section.
A request XML packet retrieving subscription limits descriptors includes the get-limit-descriptor operation node:
<packet>
<webspace>
<get-limit-descriptor>
...
</get-limit-descriptor>
</webspace>
</packet>
You can retrieve limits descriptor for the specified subscription (or multiple subscriptions specified by customer ID or login name), or the server-level subscription limits descriptor. The get-limit-descriptor node has the following graphical representation:
domain_input.xsd
).The get-limit-descriptor node of the output XML packet is structured as follows:
plesk_common.xsd
). Note: This descriptor contains limits extensions. For details, refer to the Extension of Limits Descriptor section.
The request packet retrieving limits descriptor for the subscription with ID 1 looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-limit-descriptor>
<filter>
<id>1</id>
</filter>
</get-limit-descriptor>
</webspace>
</packet>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.3.0">
<webspace>
<get-limit-descriptor>
<result>
<status>ok</status>
<filter-id>1</filter-id>
<id>1</id>
<descriptor>
<property>
<name>max_site</name>
<type>int</type>
<writable-by>admin</writable-by>
<label>Domains</label>
<extension>
<shared>false</shared>
</extension>
</property>
...
</descriptor>
</result>
</get-limit-descriptor>
</webspace>
</packet>
The request packet retrieving limits descriptor for subscriptions with ID 5 and ID 7 looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-limit-descriptor>
<filter>
<name>5</name>
<name>7</name>
</filter>
</get-limit-descriptor>
</webspace>
</packet>
The request packet retrieving limits descriptor for subscriptions of the client specified by ID 3 looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-limit-descriptor>
<filter>
<owner-id>3</owner-id>
</filter>
</get-limit-descriptor>
</webspace>
</packet>
The request packet retrieving the server-level descriptor of subscription limits looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-limit-descriptor>
<filter/>
</get-limit-descriptor>
</webspace>
</packet>