Use the get-physical-hosting-descriptor operation to retrieve descriptors of hosting settings set for service 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 service plan hosting settings includes the get-physical-hosting-descriptor operation node:
<packet>
<service-plan>
<get-physical-hosting-descriptor>
...
</get-physical-hosting-descriptor>
</service-plan>
</packet>
The get-physical-hosting-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-physical-hosting-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 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>
<get-physical-hosting-descriptor>
<filter>
<name>base_plan</name>
</filter>
<get-physical-hosting-descriptor>
</service-plan>
</packet>
A positive response received from the server looks as follows:
<packet>
<service-plan>
<get-physical-hosting-descriptor>
<result>
<status>ok</status>
<name>base_plan</name>
<descriptor>
...
<property>
<name>miva</name>
<type>boolean</type>
<writable-by>none</writable-by>
<label>__miva_unix_support</label>
<extension>
<service>
<domain>1</domain>
<subdomain>1</subdomain>
</service>
</extension>
</property>
...
<bind>
<ref>webstat_protected</ref>
<relevant>
<name>webstat</name>
<value>none</value>
</relevant>
<read-only>1</read-only>
</bind>
...
</descriptor>
</result>
</get-physical-hosting-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-physical-hosting-descriptor>
<filter>
<name>base_plan</name>
<name>quick_plan</name>
</filter>
</get-physical-hosting-descriptor>
</service-plan>
</packet>