API, API Platform, API-PCS, Groovy, iterations, Oracle, Script, Technology, utility, versions
The new Oracle API Platform makes it possible to deploy different versions of your APIs to different gateway instances. When you you’re managing the Development API Policies through all the different stages of the lifecycle (Design to Production) from a single management tier such a capability is essential. This is further challenged by the fact that each save of you API Definition creates a new iteration (the term used to identify each saved ‘version’ of the API)
However it does lead the challenge from a management perspective of knowing which iterations are running on each Gateway.. you can get the information from the current UI but it requires multiple steps to get the information. The UI also lends itself more to the design processes today than perhaps the more dense information views that a operational report might warrant.
I’m sure that over time these views will come, but today we can solve the problem by taking advantage of the fact that the product lives by its own ‘mission’ by offering a very rich set of APIs. As a result it becomes possible to actually build your own views. To that end I have written a Groovy script which will go through each API that can be seen and retrieves the iteration deployed to each logical gateway.
In terms of running the script you obviously need Groovy installed. It expects 3 parameters which are: Server address e.g. https://22.214.171.124 Username e.g. weblogic Password e.g. Welcome1 You can hardwire into the script default values which will then be used if no parameters are provided.
Here is a screenshot of some output. I have masked out some information for reasons of security. But there should be enough here to give a sense of what is happening:
The script includes suppressing certificate validation – necessary if you haven’t yet deployed your own specific certificate and still working with the default Oracle certificate.
Feel free to take the script and play with it. I make no claims to it’s elegance etc but I have tried to comment it so you can see what is going on. I have tried to keep the code fairly simple so you can see how it works and processes the JSON responses. The script is available at: https://github.com/mp3monster/Utils/blob/master/getDeployedIterations.groovy
For more about the APIs involved in the script, checkout
Pingback: PaaS (Process & Integration) Partner Community Newsletter February 2018 | SOA Community Blog
Pingback: Managing API Policy Versioning in Oracle API Platform | MP3Monster's Blog
Pingback: Understanding API Deployment State on API Platform by Phil Wilkins | SOA Community Blog
Pingback: Managing API Policy Versioning in Oracle API Platform by Phil Wilkins | SOA Community Blog
Pingback: Making Scripts Work with IDCS Deployed PaaS | Phil (aka MP3Monster)'s Blog
Pingback: Notifications from Oracle API Platform Cloud Service | Phil (aka MP3Monster)'s Blog