Documentation
Abiquo has added a layer concept in order to offer anti-affinity host allocation for virtual machines. This means that a virtual appliance can have different layers, and a virtual machine can belong to a layer (it is not mandatory). Virtual machines with the same layer will deploy on different hosts to assure the stability of the virtual appliance.
This class operates mainly over the Resource URI: /cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers
Retrieve a list of layers with their virtual machines.
Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers
Roles Required: ROLE_VDC_ENUMERATE,ROLE_VAPP_MANAGE_LAYERS
Request Headers: Accept:
application/vnd.abiquo.layers+json; version=3.10; application/vnd.abiquo.layers+xml; version=3.10; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
---|---|---|---|
|
|
|
|
Request Message Body Entity:
Response Message Body Entity: Layers Media Type
Request Example:
Creates a new layer given a name and a single virtual machine (in any state)
Synopsis: POST http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers
Roles Required: ROLE_VAPP_MANAGE_LAYERS
Request Headers: Accept:
application/vnd.abiquo.layer+json; version=3.10; application/vnd.abiquo.layer+xml; version=3.10; Content-type:
application/vnd.abiquo.layer+json; version=3.10; application/vnd.abiquo.layer+xml; version=3.10;
Request Parameters:
Parameter | Required | Default Value | Description |
---|---|---|---|
|
|
|
|
Request Message Body Entity: Layer Media Type
Response Message Body Entity: Layer Media Type
Request Example:
Retrieve the list of virtual machines of a given layer.
Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers/{layer}
Roles Required: ROLE_VDC_ENUMERATE,ROLE_VAPP_MANAGE_LAYERS
Request Headers: Accept:
application/vnd.abiquo.layer+json; version=3.10; application/vnd.abiquo.layer+xml; version=3.10; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
---|---|---|---|
|
|
|
|
Request Message Body Entity:
Response Message Body Entity: Layer Media Type
Request Example:
The layer should be empty, with a single virtual machine in any state.
Synopsis: DELETE http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers/{layer}
Roles Required: ROLE_VAPP_MANAGE_LAYERS
Request Headers: Accept: ; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
---|---|---|---|
|
|
|
|
Request Message Body Entity:
Response Message Body Entity:
Request Example:
Modify the name of a layer and its virtual machines.
Synopsis: PUT http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/layers/{layer}
Roles Required: ROLE_VAPP_MANAGE_LAYERS
Request Headers: Accept:
application/vnd.abiquo.layer+json; version=3.10; application/vnd.abiquo.layer+xml; version=3.10; Content-type:
application/vnd.abiquo.layer+json; version=3.10; application/vnd.abiquo.layer+xml; version=3.10;
Request Parameters:
Parameter | Required | Default Value | Description |
---|---|---|---|
|
|
|
|
Request Message Body Entity: Layer Media Type
Response Message Body Entity: Layer Media Type
Request Example: