Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.4

Skip to end of metadata
Go to start of metadata

Remote Services Resource

Contents:

From Abiquo 3.2 the Remote Service resource for regions only allows you to retrieve the remote services assigned to the region. The remote services are now managed from an independent resource: see  Remote Services Resource

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/publiccloudregions/{publiccloudregion}/remoteservices

Exposed Methods

List remote services of a public cloud region

Returns all remote services from a given public cloud region.

Synopsis: GET http://example.com/api/admin/publiccloudregions/{publiccloudregion}/remoteservices
Roles Required: ROLE_PHYS_DC_ENUMERATE
Request Headers: Accept: application/vnd.abiquo.remoteservices+json; version=4.4; application/vnd.abiquo.remoteservices+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: RemoteServices Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_pubcldregs_X_rs_AC_rs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/790/remoteservices \ 
	 -H 'Accept:application/vnd.abiquo.remoteservices+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "status": 1, 
      "uuid": "81", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/remoteservices/1259", 
          "type": "application/vnd.abiquo.remoteservice+json", 
          "rel": "edit", 
          "title": "VIRTUALSYSTEMMONITOR"
        }, 
        {
          "href": "http://localhost:9009/api/admin/remoteservices/1259/action/check", 
          "type": "", 
          "rel": "check", 
          "title": "check"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/790", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "publiccloudregion", 
          "title": "80"
        }
      ], 
      "type": "VIRTUAL_SYSTEM_MONITOR", 
      "uri": "http://localhost:8080/vsm", 
      "id": 1259
    }, 
    {
      "status": 1, 
      "uuid": "82", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/remoteservices/1260", 
          "type": "application/vnd.abiquo.remoteservice+json", 
          "rel": "edit", 
          "title": "NODECOLLECTOR"
        }, 
        {
          "href": "http://localhost:9009/api/admin/remoteservices/1260/action/check", 
          "type": "", 
          "rel": "check", 
          "title": "check"
        }, 
        {
          "href": "http://localhost:9009/api/admin/publiccloudregions/790", 
          "type": "application/vnd.abiquo.publiccloudregion+json", 
          "rel": "publiccloudregion", 
          "title": "80"
        }
      ], 
      "type": "NODE_COLLECTOR", 
      "uri": "http://localhost:8080/nodecollector", 
      "id": 1260
    }
  ]
}

Get a remote service of a public cloud region

Returns a remote service from a public cloud region given the remote service type.

Synopsis: GET http://example.com/api/admin/publiccloudregion/{publiccloudregion}/remoteservices/{remoteservice}
Roles Required: ROLE_PHYS_DC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.remoteservice+json; version=4.4; application/vnd.abiquo.remoteservice+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: RemoteService Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_pubcldregs_X_rs_VIRTUALFACTORY_AC_rs_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/publiccloudregions/4357/remoteservices/VIRTUALFACTORY \ 
	 -H 'Accept:application/vnd.abiquo.remoteservice+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "status": 1, 
  "uuid": "434", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/remoteservices/9963", 
      "type": "application/vnd.abiquo.remoteservice+json", 
      "rel": "edit", 
      "title": "VIRTUALFACTORY"
    }, 
    {
      "href": "http://localhost:9009/api/admin/remoteservices/9963/action/check", 
      "type": "", 
      "rel": "check", 
      "title": "check"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/4357", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "publiccloudregion", 
      "title": "430"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4356", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "426"
    }, 
    {
      "href": "http://localhost:9009/api/admin/publiccloudregions/4358", 
      "type": "application/vnd.abiquo.publiccloudregion+json", 
      "rel": "publiccloudregion", 
      "title": "433"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4355", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "424"
    }
  ], 
  "type": "VIRTUAL_FACTORY", 
  "uri": "http://localhost:8080/virtualfactory", 
  "id": 9963
}