Use the get-physical-hosting-descriptor operation to retrieve descriptors of hosting settings set for add-on plans. For details on descriptors, refer to the Representation of Object Descriptor section. For details on hosting settings, refer to the Hosting Settings section.
A request XML packet retrieving descriptor of add-on plan hosting settings includes the get-physical-hosting-descriptor operation node:
<packet>
<service-plan-addon>
<get-physical-hosting-descriptor>
...
</get-physical-hosting-descriptor>
</service-plan-addon>
</packet>
The get-physical-hosting-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-physical-hosting-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 hosting settings extensions. For details, refer to the Representation of Object Descriptors: Property Descriptor > Extension of Limits Descriptor section.
The following packet retrieves hosting settings descriptor for a service plan:
<packet>
<service-plan-addon>
<get-physical-hosting-descriptor>
<filter>
<name>base_plan</name>
</filter>
<get-physical-hosting-descriptor>
</service-plan-addon>
</packet>
Response:
<packet>
<service-plan-addon>
<get-physical-hosting-descriptor>
<result>
<status>ok</status>
<name>1 Additional Gigabyte</name>
<descriptor>
<property>
<name>ftp_quota</name>
<type>bytes</type>
<writable-by>none</writable-by>
<label>__hard_disk_quota</label>
<extension>
<levels>domain</levels>
<levels>subdomain</levels>
</extension>
</property>
<property>
<name>fp_auth</name>
<type>boolean</type>
<writable-by>none</writable-by>
<label>__fp_unix_auth</label>
<extension>
<levels>domain</levels>
</extension>
</property>
...
<bind>
<ref>cgi_mode</ref>
<relevant>
<name>cgi</name>
<value>true</value>
</relevant>
<read-only>0</read-only>
</bind>
...
</descriptor>
</result>
</get-physical-hosting-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-physical-hosting-descriptor>
<filter>
<name>base_plan</name>
<name>quick_plan</name>
</filter>
</get-physical-hosting-descriptor>
</service-plan-addon>
</packet>