Use the get-limit-descriptor operation to retrieve limits descriptors of service plans. For details on the limits descriptors, refer to the Representation of Object Descriptors section. For details on limits of service plans, refer to the Limits section.
A request XML packet retrieving service plan limits includes the get-limit-descriptor operation node:
<packet>
<service-plan>
<get-limit-descriptor>
...
</get-limit-descriptor>
</service-plan>
</packet>
The get-limit-descriptor node is presented by type DomainTemplateGetInputType (domain_template.xsd)
. Its graphical representation is as follows:
domain_template.xsd
). See the Available Filters section for details on this node.
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
The get-limit-descriptor node of the output XML packet is of type DomainTemplateDescriptorOutput (domain_template.xsd
) which is structured as follows:
common.xsd
).common.xsd
). Allowed values: ok|error
.common.xsd
).common.xsd
).common.xsd
).common.xsd
).Note: This descriptor contains limits extensions. For details, refer to the Representation of Object Descriptors: Property Descriptor > Extension of Limits Descriptor section.
The following packet retrieves limits descriptor for a service plan:
<packet>
<service-plan>
<get-limit-descriptor>
<filter>
<name>base_plan</name>
</filter>
</get-limit-descriptor>
</service-plan>
</packet>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
<service-plan>
<get-limit-descriptor>
<result>
<status>ok</status>
<name>base_plan</name>
<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>
</service-plan>
</packet> Note: Data structures that describe a number of properties are omitted to improve the readability of the sample.
A single filter can specify multiple plans, all specified either by ID or by name.
<packet>
<service-plan>
<get-limit-descriptor>
<filter>
<name>base_plan</name>
<name>quick_plan</name>
</filter>
</get-limit-descriptor>
</service-plan>
</packet>