Eco4Cloud

URL: http://e4c_appliance_address/api/Login

The request can be completed in GET or POST method, using the following parameters.

The result will be a JSON string with the following structure.

URL: http://e4c_appliance_address/api/<entity>/get?<parameters>

The keyword “<entity>” specifies which kind of resource the client is querying for. The possible values are the following.

The keyword “<parameters>” gives the possibility to apply filters on the extraction of data. Each request returns a JSON string representing the specified entity. The filters applied and the structure of the output depends on the type of entity specified in the request.

After the keyword “<parameters>”, it is also possible to append the option “&page=<page_number>”, in order to limit the number of results to fetch. Each page will list a maximum of 20 entities, so it will possible to fetch another page of results as soon as the listed entities in a page will be equal to 20.

URL: http://e4c_appliance_address/api/Farm/get?<parameters>

The following filters are allowed.

The result will be a JSON string with the following structure.

Example: get a server farm chosen by its name

GET http://e4c_appliance_address/api/Farm/get?name=test_farm

{
   "Farms":[
      {
         "name":"test_farm",
         "description":"test_farm",
         "ta":"80",
         "th":"90",
         "consolidation_on":"true"
      }
   ]
}


URL: http://e4c_appliance_address/api/Cluster/get?<parameters>

The following filters are allowed.

The result will be a JSON string with the following structure.

Example: list the clusters in a specific farm

GET http://e4c_appliance_address/api/Cluster/get?name=cluster_test&farm_name=test_farm

{
   "Clusters":[
      {
         "name":"cluster_test",
         "uuid":"datacenter-2_domain-c7",
         "servers_always_on":"1",
         "consolidation_enabled":"true",
         "Farm":"icar",
         "power_off_min_uptime":"10",
         "power_on_min_downtime":"10",
         "drs_mode":"nothing"
      }
   ]
}


URL: http://e4c_appliance_address/api/Host/get?<parameters>

The following filters are allowed.

The result will be a JSON string with the following structure.

Example: get the host named “test_host_1″

GET http://e4c_appliance_address/api/Host/get?name=test_host_1

{
   "Hosts":[
      {
         "name":"test_host_1",
         "uuid":"datacenter-2_host-547",
         "powered_on":"true",
         "cpu_frequency":"2266.00",
         "cpu_cores":"8",
         "ram_mb":"24567",
         "bandwidth":"1000",
         "standby_enabled":"true",
         "Cluster":"cluster_test",
         "Farm":"test_farm",
         "power_off_min_uptime":"30",
         "power_on_min_downtime":"11",
         "ipmi_ip":"",
         "ipmi_username":"",
         "ipmi_password":"",
         "Performance":[
            {
               "performance_date":"2014-07-07 16:59:54",
               "cpu":"2.28",
               "mem":"51.74",
               "bandwidth_usage":"0.11",
               "power":"0.00"
            }
         ]
      }
   ]
}


URL: http://e4c_appliance_address/api/Vm/get?<parameters>

The following filters are allowed.

The result will be a JSON string with the following structure.

Example: get the virtual machine named “test_vm_1″

GET http://e4c_appliance_address/api/vm/get?name=test_vm_1

{  
   “Vms”:[  
      {  
         “name”:“test_vm_1″,
         “uuid”:“datacenter-2_vm-124″,
         “operating_system”:“”,
         “assigned_cores”:“8”,
         “assigned_memory_mb”:“3072”,
         “migration_enabled”:“true”,
         “cluster_migration_enabled”:“false”,
         “Host”:“test_host_1″,
         “Cluster”:“cluster_test”,
         “Farm”:“test_farm”,
         “Performance”:[  
            {  
               “performance_date”:“2014-07-07 15:40:56″,
               “cpu”:“0.00”,
               “mem”:“0.00”,
               “bandwidth”:“0.00”,
               “active_memory”:“0.00”,
               “compressed_memory”:“0.00”,
               “swapped_memory”:“0.00”,
               “ballooned_memory”:“0.00”
            }
         ]
      }
   ]
}

URL: http://e4c_appliance_address/api/DataStore/get?<parameters>

The following filters are allowed.

The result will be a JSON string with the following structure.

Example: get the list of datastores attached to host “test_host_1″

GET http://e4c_appliance_address/api/DataStore/get?host_name=test_host_1

{  
  “DataStore”:[  
    {  
      “name”:“test_datastore_1″,
      “uuid”:“datacenter-2_datastore-10″,
      “Farm”:“test_farm”,
      “Performance”:[  
        {  
          “performance_date”:“2014-07-07 16:59:54″,
          “io”:“0.00”
        }
      ]
    },
    {  
      “name”:“test_datastore_2″,
      “uuid”:“datacenter-2_datastore-548″,
      “Farm”:“test_farm”,
      “Performance”:[  
        {  
          “performance_date”:“2014-07-07 16:59:54″,
          “io”:“0.00”
        }
      ]
    }
  ]
}

URL: http://e4c_appliance_address/api/<entity>/set

The keyword “<entity>” specifies which kind of resource the client is changing settings for. The possible values are the following.

Each SET operation takes as input a JSON string specifying the parameters to be changed and the conditions to be verified. The general structure of the string is as follows.

{
    "setList":[
        {"name":"<parameter1>","value":"<value1>"},
        {"name":"<parameter2>","value":"<value1>"},
        ...
    ],
    "whereList":[
        {"name":"<condition1>","value":"<value1>"},
        {"name":"<condition2>","value":"<value1>"},
        ...
    ]
}

The allowed values for the Setlist and WhereList depend on the entity specified in the request.

The result is a JSON string with the following structure.

URL: http://e4c_appliance_address/api/Farm/set

The following SetList is allowed.

The following WhereList is allowed.

Example: allow workload consolidation

POST http://e4c_appliance_address/api/Farm/set

DATA {“setList”:[{“name”:”consolidation_on”,”value”:”true”}],”whereList”:[{“name”:”name”,”value”:”test_farm”}]}

{  
  “result”:“ok”,
  “rows_affected”:1
}

URL: http://e4c_appliance_address/api/Cluster/set

The following SetList is allowed.

The following WhereList is allowed.

Example: stop workload consolidation on a specific cluster

POST http://e4c_appliance_address/api/Cluster/set

DATA {“setList”:[{“name”:”consolidation_enabled”,”value”:”false”}],”whereList”:[{“name”:”name”,”value”:”cluster_test”}]}

{  
  “result”:“ok”,
  “rows_affected”:1
}

URL: http://e4c_appliance_address/api/Host/set

The following SetList is allowed.

The following WhereList is allowed.

Example: allow host switch off

POST http://e4c_appliance_address/api/Host/set

DATA {“setList”:[{“name”:”standby_enabled”,”value”:”true”}],”whereList”:[{“name”:”name”,”value”:”test_host_4″}]}

{  
  “result”:“ok”,
  “rows_affected”:1
}

URL: http://e4c_appliance_address/api/Vm/set

The following SetList is allowed.

The following WhereList is allowed.

Example: flag a VM as migratable

POST http://e4c_appliance_address/api/Vm/set

DATA {“setList”:[{“name”:”migration_enabled”,”value”:”true”}],”whereList”:[{“name”:”name”,”value”:”test_vm_1″}]}

{  
  “result”:“ok”,
  “rows_affected”:1
}