Listing Provisioning Tasks

To get a list of all provisioning tasks, use the operation task-list.

Request

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

Response

<packet>
  <extension>
    <call>
      <result>
        <status>ok</status>
        <plesk-multi-server>
          <task-list>
            <task>
              <id>1</id>
              <parent-id/>
              <customer-id/>
              <subscription-id/>
              <service-plan-id/>
              <node-id>1</node-id>
              <status>done</status>
              <status-message/>
              <object-name>1.1.1.1</object-name>
            </task>
            <task>
              <id>2</id>
              <parent-id/>
              <customer-id/>
              <subscription-id/>
              <service-plan-id/>
              <node-id>1</node-id>
              <status>failed</status>
              <status-message>Failed API request: Template with name Admin Simple already exists</status-message>
              <object-name>2.2.2.2</object-name>
            </task>
          </task-list>
        </plesk-multi-server>
      </result>
    </call>
  </extension>
</packet>

Use optional filters to narrow down the list of provisioning tasks according to search parameters.

Request

<packet>
  <extension>
    <call>
      <plesk-multi-server>
        <task-list>
          <filter-id>1,2,3</filter-id>
          <filter-status>done,failed</filter-status>
          <filter-customer-id>1,2,3</filter-customer-id>
          <filter-subscription-id>1,2,3</filter-subscription-id>
          <filter-service-plan-id>1,2,3</filter-service-plan-id>
          <filter-node-id>1,2,3</filter-node-id>           
        </task-list>
      </plesk-multi-server>
    </call>
  </extension>
</packet>

Possible values for filter-status:

  • new
  • queue
  • running
  • done
  • error
  • prepare queue
  • prepare running
  • waiting
  • blocked
 

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.