Use the get-limit-descriptor operation to retrieve limits descriptor of add-on 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 add-on plan limits includes the get-limit-descriptor operation node:
<packet>
<service-plan-addon>
<get-limit-descriptor>
...
</get-limit-descriptor>
</service-plan-addon>
</packet>
The get-limit-descriptor node is presented by type DomainAddonTemplateGetInputType (domain_addon_template.xsd)
. Its graphical representation is as follows:
domain_addon_template.xsd
). See the Available Filters section for details on this node.The get-limit-descriptor node of the output XML packet is of type DomainAddonTemplateDescriptorOutput (domain_addon_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-addon>
<get-limit-descriptor>
<filter>
<name>base_plan</name>
</filter>
</get-limit-descriptor>
</service-plan-addon>
</packet>
Response:
<packet>
<service-plan-addon>
<get-limit-descriptor>
<result>
<status>ok</status>
<name>1 Additional Gigabyte</name>
<descriptor>
<property>
<name>max_site</name>
<type>int</type>
<writable-by>admin</writable-by>
<label>limit__max_site</label>
<extension>
<shared>false</shared>
</extension>
</property>
<property>
<name>max_subdom</name>
<type>int</type>
<writable-by>admin</writable-by>
<label>limit__max_subdom</label>
<extension>
<shared>false</shared>
</extension>
</property>
...
</descriptor>
</result>
</get-limit-descriptor>
</service-plan-addon>
</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-addon>
<get-limit-descriptor>
<filter>
<name>base_plan</name>
<name>quick_plan</name>
</filter>
</get-limit-descriptor>
</service-plan-addon>
</packet>