Breaking down the UCS Director and Intercloud Fabric API

The Rest API that you can use to access both UCSD and ICFB have similar origins therefore they work in a similar way.

I have written blogs on how to access the API but thought it would be useful to break down the key elements involved in the calls.

In the URL syntax 3 values are specified;

  • opName - specifying the action
  • opData - specifying the data the call will use this a JSON formatted string included on the URL.
  • formatType - specifying the requested return data type JSON or XML
opName

The opName specifies the action

Examples of these are (check the API documentation on the Cisco website for the definitive list);

  • userAPIGetAllVDCs
  • Intercloud:userAPIVmPowerOff
  • userAPIGetServiceRequestDetails
  • Intercloud:userAPIGetAllVms
  • userAPIGetAllVms
opData

The opData specifies the data to be used by the call (JSON formatted string in the URL). This is the part you pass the various parameters.

formatType

Specifies the requested return data type, this can be JSON for XML.

Return Values

There are four sections at the very end of each response;

+ serviceResult
+ serviceError
+ serviceName
+ opName

An example is (call made to ICFB);

{
  "serviceResult": 0,
  "serviceError": null,
  "serviceName": "InfraMgr",
  "opName": "Intercloud:userAPIVmPowerOff"
}
Show Comments

Get the latest posts delivered right to your inbox.