Pool Status

This API method gets the status of a resource pool—a group of resources, such as IP addresses and mongrels—so you can track resource usage data across workflows.

Usage (GET method)

Orchestrator uses basic authorization in the request.

Note: The default format for the response is XML format. To return a response in JSON format, add format=json to the request.

Note: You must use URL encoding for any special characters in parameter values, including username and password.

Note: You may have seen one or more pool names represented as pool_name__a in the database. This appended part of the pool name is always represented as underscore underscore a ("__a"). The request will be successful with or without the "__a". Either request below is acceptable and will return the same results:

https://Orchestrator_IP_address/aspera/orchestrator/api/pool_status?name=pool_name&login=username

https://Orchestrator_IP_address/aspera/orchestrator/api/pool_status?name=pool_name__a&login=username

For example:

https://10.0.71.99/aspera/orchestrator/api/pool_status?name=load_test&login=admin

https://10.0.71.99/aspera/orchestrator/api/pool_status?name=load_test__a&login=admin

Parameters

Parameter Name	Required	Data Type	Definition
`name`	true	string	Name of the resource pool

Response

XML Response

<PoolStatus>
   <ManagedResource>
      <id>127.0.0.7</id>
      <taken>0</taken>
      <capacity>1</capacity>
   </ManagedResource>
</PoolStatus>

JSON Response

{
  "ManagedResource": [
    {
      "id": "127.0.0.7",
      "taken": 0,
      "capacity": 1,
      "status": "online"
    }
  ]
}

Response Attributes

Parameter Name	Data Type	Definition	Example
`id`	string	ID of the resource	127.0.0.7
`taken`	integer	Number of resources currently in use	0
`capacity`	integer	Maximum number of potentially available resources	1