Tech Tip: Using the RESTful Control API with Python - listpoolnodes

ricknelson · ‎02-27-2013

The following code uses Stingray's RESTful API to list all the pools defined for a cluster and for each pool it lists the nodes defined for that pool, including draining and disabled nodes. The code is written in Python. This example builds on the previous listpools.py example. This program does a GET request for the list of pool and then while looping through the list of pools, a GET is done for each pool to retrieve the configuration parameters for that pool.

listpoolnodes.py

#! /usr/bin/env python

import requests

import json

import sys

print "Pools:\n"

url = 'https://stingray.example.com:9070/api/tm/1.0/config/active/pools'

jsontype = {'content-type': 'application/json'}

client = requests.Session()

client.auth = ('admin', 'admin')

client.verify = False

try:

# Do the HTTP GET to get the lists of pools. We are only putting this client.get within a try

# because if there is no error connecting on this one there shouldn't be an error connnecting

# on later client.get so that would be an unexpected exception.

response = client.get(url)

except requests.exceptions.ConnectionError:

print "Error: Unable to connect to " + url

sys.exit(1)

data = json.loads(response.content)

if response.status_code == 200:

if data.has_key('children'):

pools = data['children']

for i, pool in enumerate(pools):

poolName = pool['name']

# Do the HTTP GET to get the properties of a pool

response = client.get(url + "/" + poolName)

poolConfig = json.loads(response.content)

if response.status_code == 200:

# Since we are getting the properties for a pool we expect the first element to be 'properties'

if poolConfig.has_key('properties'):

# The value of the key 'properties' will be a dictionary containing property sections

# All the properties that this program cares about are in the 'basic' section

# nodes is the list of all active or draining nodes in this pool

# draining the list of all draining nodes in this pool

# disabled is the list of all disabled nodes in this pool

nodes = poolConfig['properties']['basic']['nodes']

draining = poolConfig['properties']['basic']['draining']

disabled = poolConfig['properties']['basic']['disabled']

print pool['name']

print " Nodes: ",

for n, node in enumerate(nodes):

print node + " ",

print ""

if len(draining) > 0:

print " Draining Nodes: ",

for n, node in enumerate(draining):

print node + " ",

print ""

if len(disabled) > 0:

print " Disabled Nodes: ",

for n, node in enumerate(disabled):

print node + " ",

print ""

else:

print "Error: No properties found for pool " + poolName

print ""

else:

print "Error getting pool config: URL=%s Status=%d Id=%s: %s" %(url + "/" + poolName, response.status_code, poolConfig['error_id'], poolConfig['error_text'])

else:

print 'Error: No chidren found'

else:

print "Error getting pool list: URL=%s Status=%d Id=%s: %s" %(url, response.status_code, data['error_id'], data['error_text'])

Running the example

This code was tested with Python 2.7.3 and version 1.1.0 of the requests library.

Run the Python script as follows:

$ listpoolnodes.py

Pools:

Pool1

Nodes: 192.168.1.100 192.168.1.101

Draining: 192.168.1.101

Disabled: 192.168.1.102

Pool2

Nodes: 192.168.1.103 192.168.1.104

Read More

Stingray REST API Guide in the Stingray Product Documentation
Not authorized to view the specified document 1584
Tech Tip: Using Stingray's RESTful Control API
Collected Tech Tips: Using the RESTful Control API

Tech Tip: Using the RESTful Control API with Python - listpoolnodes

Tech Tips