r20 - 14 Oct 2010 - 16:11:42 - ApoorvaKulkarniYou are here: Wiki >  AppLogic29 Web > RefWebServiceAPI
ALERT! AppLogic 2.9 Documentation The latest production release is AppLogic 3.0.30

AppLogic Web Service API Reference

Latest version: 1.0.3-1 BETA

ALERT! The Web Service API is only available in the AppLogic 2.9 limited availability release and later versions.

The AppLogic application programming interface (API) supports programming styles based on the principles of Representational State Transfer (REST). AppLogic web Services API enables developers of RESTful client software to directly interface with AppLogic based Virtual Data Centers (VDC)(i.e., an AppLogic grid). The API allows for programmatic control of large pools of virtualized infrastructure to be available within each VDC. In order to use the Web Service API, the 'WS_API' application should be running on a grid. The 'WS_API' AppLogic application provides HTTP,HTTPS and VPN based access to the REST API. The datasheet for the 'WS_API' application can be found here.

The following table gives a brief overview of valid objects for the AppLogic REST API. For more information on a particular object and its valid methods please see the reference for the individual objects.

Name Object Description
virtual data center vdc View details of one or more vdc Virtual Data Centers managed by the 'WS_API'
server srv Manage servers of a VDC through it's controller
template template Provision applications from a template, Manage existing templates
application app Configure and Manage applications on a VDC
component comp Manage components on a VDC
interfaces iface Manage interfaces on a application running on a VDC
volume vol Manage volumes related to an application
catalog cat Manage catalogs on a VDC
class class Manage class objects on a VDC
user user Manage AppLogic Editor and 3t Shell user accounts
log log View controller system log data from a VDC
message msg View message related events on a VDC
ha ha Check the HA (High Availability State) of a VDC
util util Access wincfg and appstore utilities on a VDC
jobs job Manage jobs running on the 'WS_API' for one or more VDC
obj obj Get list and info for API objects


API Generic Syntax

To initiate an API request for an object,use a command with the following format
GET "http://ws-ip/api/v1/obj/method?arg1=<value>&arg2=<value>&vdc=<grid>"
Where:
   ws-ip is the IP address used to access the 'WS_API' application
   object is an API object such as app, class, etc.
   method is the action to be performed for the object such as start, stop, etc.
   arg1, arg2 are the arguments to be passed to the method
   vdc is the name of the grid controller
Example: Get the methods for object app
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid

Example Output: 
{
   "method" : [
      {
         "name" : "config"
      },
      {
         "name" : "copy"
      },
      {
         "name" : "create"
      },
      {
         "name" : "destroy"
      },
      .
      .
      .
   ]
}

Output Formats

The acceptable output formats can be XML or JSON. These can be specified in the API request.
Example:
Get the methods for object app in XML format.
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/xml"
Get the methods for object app in JSON format.
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/json"

-- ApoorvaKulkarni - 12 Apr 2010

 
Copyright © CA 2005-2012. All Rights Reserved.
%