Use the get-physical-hosting-descriptor operation to retrieve descriptor of domain hosting settings. For details on descriptors, refer to the Representation of Object Descriptor section. For details on hosting settings, refer to the Hosting Settings section.

Request Packet Structure

A request XML packet retrieving descriptor of hosting settings includes the get-physical-hosting-descriptor operation node:

<packet version="1.6.3.0">
<webspace>
   <get-physical-hosting-descriptor>
   ...
   </get-physical-hosting-descriptor>
</webspace>
</packet>

You can retrieve descriptor for the specified subscription (or multiple subscriptions specified by customer ID or login name) or the server-level descriptor of hosting settings. The get-physical-hosting-descriptor node has the following graphical representation:

• The filter node is required. It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors section. Data type: domainFilterType (domain_input.xsd).

Response Packet Structure

The get-physical-hosting-descriptor node of the output XML packet is structured as follows:

• The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (plesk_common.xsd).
• The status node is required. It specifies the execution status of the get-physical-hosting-descriptor operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. It is used to return the error code when the get-physical-hosting-descriptor operation fails. Data type: unsignedInt.
• The errtext node is optional. Can be used to return the error message if the get-physical-hosting-descriptor operation fails. Data type: string.
• The filter-id node is optional. It is required if the get-physical-hosting-descriptor operation succeeds. Returns either subscription name, subscription ID, customer name, or customer ID depending on a way of descriptor’s specification in the request packet. For info on filters, refer to the Filters of Descriptors section. Data type: anySimple.
• The id node is optional. It is required if the get-physical-hosting-descriptor operation succeeds. Returns the unique identifier of the subscription. Data type: integer.
• The descriptor node is optional. It specifies the object descriptor. For details, refer to Representation of Object Descriptor. Data type: string.

Samples

The request packet retrieving descriptor of hosting settings for the subscription with ID 5 looks as follows:

<packet version ="1.6.3.0">
<webspace>
   <get-physical-hosting-descriptor>
      <filter>
         <id>5</id>
      </filter>
   </get-physical-hosting-descriptor>
</webspace>
</packet>

Response:

<packet version="1.6.3.0">
  <webspace>
    <get-physical-hosting-descriptor>
      <result>
        <status>ok</status>
        <filter-id>MyDomain.com</filter-id>
        <id>5</id>
        <descriptor>
          <property>
            <name>ftp_login</name>
            <type>string</type>
            <writable-by>admin</writable-by>
            <label>hst_def__fp_admin_login</label>
          </property>
          <property>
            <name>fp_admin_password</name>
            <type>passwordString</type>
            <writable-by>none</writable-by>
            <label>hst_def__fp_admin_passwd</label>
          </property>
...
</descriptor></result></get-physical-hosting-descriptor>
</webspace></packet>

The request packet retrieving descriptor of hosting settings for subscriptions with ID 5 and ID 7 looks as follows:

<packet version ="1.6.3.0">
<webspace>
   <get-physical-hosting-descriptor>
      <filter>
         <name>5</name>
         <name>7</name>
      </filter>
   </get-physical-hosting-descriptor>
</webspace>
</packet>

The request packet retrieving descriptor of hosting settings for subscriptions of the customer specified by ID 3 looks as follows:

<packet version ="1.6.3.0">
<webspace>
   <get-physical-hosting-descriptor>
      <filter>
         <owner-id>3</owner-id>
      </filter>
   </get-physical-hosting-descriptor>
</webspace>
</packet>

The request packet retrieving the server-level descriptor of hosting settings looks as follows:

<packet version ="1.6.3.0">
<webspace>
   <get-physical-hosting-descriptor>
      <filter/>
   </get-physical-hosting-descriptor>
</webspace>
</packet>