Intro to CloudStack API
Download as PPT, PDF11 likes13,583 views
A walk through of the CloudStack API. full screencast available at http://www.youtube.com/watch?v=ZPfm2EksIbc An API to your cloud orchestrator is key to automation of your data center. We go through the basics of Query API calls, unauthenticated on the integration port and authenticated calls using the access and secret keys of a users and computing a signature. We show how to compute a signature in Python. We also highlight various CloudStack clients in many different languageas (java, php, ruby, clojure etc..) and show how to explore the API using firebug console in firefox or via the CloudStack interfactive shell cloudmonkey. This is a good complement to my talk on CloudMonkey.
![Example
>>> request
{'apikey': 'plgWJfZK4gyS3mOMTVmjUVg-X-jlWlnfaUJ9GAbBbf9EdM-
kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mg', 'command': 'listUsers',
'response': 'json'}
>>>request_url="&".join(["=".join([r,urllib.quote_plus(request[r])
]) for r in request.keys()])
>>>sig_url="&".join(["=".join([r.lower(),urllib.quote_plus(request
[r]).lower()]) for r in sorted(request.iterkeys())])
>>>sig=urllib.quote_plus(base64.encodestring(hmac.new(secretkey,si
g_url,hashlib.sha1).digest()).strip())
>>> req=url+request_url+'&signature='+sig
>>> res=urllib2.urlopen(req)
>>> res.read()](https://image.slidesharecdn.com/cs-introtoapi-130425064122-phpapp01/85/Intro-to-CloudStack-API-12-320.jpg)
![Exercise
@app.route('/login', methods=['GET', 'POST'])
def login():
if request.method == 'POST':
do_the_login()
else:
show_the_login_form()
curl -X DELETE
http://localhost:5000/user/b3b60a8dfdf6f-4ce6-a6f9-
6194907457a5
{ "deleteuserresponse" : { "success" : "true"} }
https://github.com/runseb/cloudstack-flask
http://buildacloud.org/blog/253-to-rest-or-not-to-rest.html](https://image.slidesharecdn.com/cs-introtoapi-130425064122-phpapp01/85/Intro-to-CloudStack-API-18-320.jpg)
![[OpenStack] ęłľę° ěíí¸ě¨ě´ ě¤íě¤í ě
돸 & íí¤ěšę¸°](https://cdn.slidesharecdn.com/ss_thumbnails/opensource-skimmingopenstackwithkoreausergroup-180824144737-thumbnail.jpg?width=560&fit=bounds)
![[OpenStack íë°ę¸° ě¤í°ë] Dockerá
á
łáŻ áá
ľáá
áźáá
ĄáŤ OpenStack áá
Ąáá
Ąáźáá
Ş](https://cdn.slidesharecdn.com/ss_thumbnails/openstackteam4dockeropenstack-151221120423-thumbnail.jpg?width=560&fit=bounds)
![[ě¤íěě¤ěť¨ě¤í
] Open Stack Ceph, Neutron, HA, Multi-Region](https://cdn.slidesharecdn.com/ss_thumbnails/openstackoscv0-160718105826-thumbnail.jpg?width=560&fit=bounds)
Ad
More Related Content
What's hot (20)
Viewers also liked (20)
![[AUG] 울ë°ě íěŠí ě
돴 íëĄě¸ě¤ íě ě¤ě˛ë˛](https://cdn.slidesharecdn.com/ss_thumbnails/aug20166s1-160629224010-thumbnail.jpg?width=560&fit=bounds)
Ad
Similar to Intro to CloudStack API (20)
Ad
More from Sebastien Goasguen (20)
Recently uploaded (20)
Intro to CloudStack API
- 1. Introduction to the CloudStack API Sebastien Goasguen @sebgoa
- 2. Outline ⢠Documentation ⢠Clients ⢠Exploration ⢠Integration port ⢠Signing requests ⢠REST or not REST
- 4. Clients ⢠15 clients and counting⌠on Github ⢠Java, Python, Perl, Ruby, C#, php, Clojure
- 5. Exploration ⢠Use a debugger console ⢠E.g Firebug ⢠As you navigate the UI, check the http calls that are being made ⢠Identify the methods ⢠Identify the parameters passed to each call
- 6. HTTP based ⢠API calls made via HTTP(s) ⢠Pass name of the call as command ⢠Pass list of key/value pairs as arguments to the call ⢠GET method ⢠Response can be XML or JSON ⢠Query API that is RESTlike http://gehrcke.de/2009/06/aws-about-api/
- 7. Integration Port ⢠Unauthenticated call â Dangerous â Donât open it all â Certainly donât open it to the public internet ⢠Set the port on the UI
- 8. Using the integration port http://localhost:8096/client/api?command=listUsers&response=json curl 'http://localhost:8096/client/api?command=listUsers&response=json' { "listusersresponse" : { "count":3 ,"user" : [ {"id":"7ed6d5da-93b2-4545-a502- 23d20b48ef2a","username":"admin","firstname":"admin","lastname":"cloud","created":"2012-07- 05T12:18:27-0700","state":"enabled","account":"admin","accounttype":1,"domainid":"8a111e58-e155- 4482-93ce-84efff3c7c77","domain":"ROOT","apikey":"plgWJfZK4gyS3mOMTVmjUVg-X-jlWlnfaUJ9GAbBbf9EdM- kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mgâ⌠http://localhost:8096/client/api?command=listUsers curl http://localhost:8096/client/api?command=listUsers <?xml version="1.0" encoding="ISO-8859-1"?><listusersresponse cloud-stack-version="3.0.3.2012-07- 04T06:31:57Z"><count>3</count><user><id>7ed6d5da-93b2-4545-a502- 23d20b48ef2a</id><username>admin</username><firstname>admin</firstname><lastname>cloud</lastname>< created>2012-07-05T12:18:27- 0700</created><state>enabled</state><account>admin</account><accounttype>1</accounttype><domainid> 8a111e58-e155-4482-93ce- 84efff3c7c77</domainid><domain>ROOT</domain><apikey>plgWJfZK4gyS3mOMTVmjUVg-X- jlWlnfaUJ9GAbBbf9EdM-kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mg⌠http://www.shapeblue.com/2012/05/10/using-the-api-for-advanced-network-management/
- 9. Authenticated calls ⢠Using http(s) ⢠API endpoint for the cloud â http://localhost:8080/client/api? ⢠Command key to pass the name of the call ⢠Key/value pairs for the arguments ⢠API key of the user making the call ⢠Signature for authorization
- 10. API Keys ⢠Generate API keys for the user that will access the cloud
- 11. Creating the signature ⢠Form the request url: list of key=value pairs joined by & and encoded for http transport ⢠Compute the signature: â lower case values, replace + with %20 â generate the hmac using sha1 hash function â Base64 encode the digest â Encode for http transport ⢠Form the entire request adding the signature: &signature=
- 12. Example >>> request {'apikey': 'plgWJfZK4gyS3mOMTVmjUVg-X-jlWlnfaUJ9GAbBbf9EdM- kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mg', 'command': 'listUsers', 'response': 'json'} >>>request_url="&".join(["=".join([r,urllib.quote_plus(request[r]) ]) for r in request.keys()]) >>>sig_url="&".join(["=".join([r.lower(),urllib.quote_plus(request [r]).lower()]) for r in sorted(request.iterkeys())]) >>>sig=urllib.quote_plus(base64.encodestring(hmac.new(secretkey,si g_url,hashlib.sha1).digest()).strip()) >>> req=url+request_url+'&signature='+sig >>> res=urllib2.urlopen(req) >>> res.read()
- 13. REST ⢠REST stands for Representational State Transfer ⢠Architectural style to design web services introduced by Roy Fielding (former ASF chair) ⢠Premise: â HTTP protocol is enough to create web services and change the state of web resources â HTTP methods can be used to change the state â Eases web services design compared to SOAP http://en.wikipedia.org/wiki/Roy_Fielding http://en.wikipedia.org/wiki/Representational_State_Transfer
- 14. REST ⢠REST style web services couple be implemented with other protocol than http ⢠But http provides all that is needed http://en.wikipedia.org/wiki/Representational_State_Transfer
- 15. REST API ⢠The CloudStack API is a query API ⢠It is RESTlike but not RESTfull ⢠Example: listUsers() a GET vs GET updateUser() a GET vs PATCH createUser() a GET vs POST deleteUser() a GET vs DELETE http://gehrcke.de/2009/06/aws-about-api/ http://publish.luisrei.com/articles/flaskrest.html
- 16. Exercise ⢠Build a REST interface to CloudStack ⢠Use Flask a Lightweight Python web framework http://flask.pocoo.org http://publish.luisrei.com/articles/flaskrest.html
- 17. Exercise from flask import Flask app = Flask(__name__) @app.route("/") def hello(): return "Hello World!" if __name__ == "__main__": app.run(debug=True) Flask allows you to define web routes and functions that get executed when these routes are called.
- 18. Exercise @app.route('/login', methods=['GET', 'POST']) def login(): if request.method == 'POST': do_the_login() else: show_the_login_form() curl -X DELETE http://localhost:5000/user/b3b60a8dfdf6f-4ce6-a6f9- 6194907457a5 { "deleteuserresponse" : { "success" : "true"} } https://github.com/runseb/cloudstack-flask http://buildacloud.org/blog/253-to-rest-or-not-to-rest.html
- 19. Info ⢠Apache Top Level Project (TLP) ⢠http://cloudstack.apache.org ⢠#cloudstack and #cloudstack-dev on irc.freenode.net ⢠@CloudStack on Twitter ⢠http://www.slideshare.net/cloudstack ⢠[email protected] ⢠[email protected] Welcoming contributions and feedback, Join the fun !