Listing Connected Service Nodes

To get a list of all service nodes currently connected, use the operation node-list.

Request

<packet>
  <extension>
    <call>
      <plesk-multi-server>
        <node-list/>
      </plesk-multi-server>
    </call>
  </extension>
</packet>

Response

<packet>
  <extension>
    <call>
      <result>
        <status>ok</status>
        <plesk-multi-server>
          <node-list>
            <node>
              <id>1</id>
              <ip>10.52.51.225</ip>
              <hostname>a10-52-51-225.qa.plesk.ru</hostname>
              <navigate-by-hostname>false</navigate-by-hostname>
              <status>active</status>
              <description>SN1</description>
              <web-shared-ipv4>10.52.51.225</web-shared-ipv4>
              <web-shared-ipv6>none</web-shared-ipv6>
            </node>
            <node>
              <id>2</id>
              <ip>10.52.61.4</ip>
              <hostname>a10-52-61-4.qa.plesk.ru</hostname>
              <navigate-by-hostname>false</navigate-by-hostname>
              <status>active</status>
              <description>SN2</description>
              <web-shared-ipv4>10.52.61.4</web-shared-ipv4>
              <web-shared-ipv6>none</web-shared-ipv6>
            </node>
          </node-list>
        </plesk-multi-server>
      </result>
    </call>
  </extension>
</packet>

Use optional filters to narrow down the list of connected nodes according to search parameters.

Request

<packet>
  <extension>
    <call>
      <plesk-multi-server>
        <node-list>
          <filter-id>1,2,3</filter-id>
          <filter-ip>1.1.1.1,2.2.2.2</filter-ip>
          <filter-hostname>example.com, example-two.com</filter-hostname>
          <filter-status>active</filter-status> 
        </node-list>
      </plesk-multi-server>
    </call>
  </extension>
</packet>

Possible values for filter-status:

  • activating
  • active
  • disabling
  • disabled
  • maintenance
  • unsupported
  • unavailable
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.