Difference between revisions of "QuantumAPISpec"

Revision as of 16:24, 12 May 2011

~+Placeholder for Quantum API Spec page

Introduction

~-This document constitutes a first attempt in defining an API for the Quantum service. The operation list cannot be deemed complete, and formats for request and response messages have not yet been defined. Moreover, authentication, authorization, and extension mechanisms, as well as the URL structure, are not defined in this document.

Since Quantum provides “network connectivity as a service”, this API defines Layer-2 operations only. This document also proposes operations for bridging Quantum networks with external networks, such as a customer-managed network in an on-premise data centre; however, use cases in this area (bridging and federation) should be explored better.

We first introduce the operation list, and then discuss how these operations can be used to accomplish some common use cases.-~

Glossary

Network

Plugin

VIF

Attachment

Logical Port

Operation List

<<Anchor(GetNetworks)>>

1.List networks

~-

Verb	URI
GET	/networks

Request Body:

This operation does not require a request body.

Description:

This operation returns the list of all networks currently defined in Quantum; returned list includes at least the network’s unique identifier.

Response Codes:

Normal Response code: 200 Error response code(s): 500 Service Unavailable, 401 Unauthorized -~

<<Anchor(GetNetworkDetails)>>

2.List network details

Verb	URI
GET	/networks/id

Request Body: This operation does not require a request body. Description: This operation provides detailed output for a specific network configured in Quantum. Response Codes: Normal Response code: 200 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized

<<Anchor(PostNetwork)>>

3.Create Network

Verb	URI
POST	/networks

Request Body: The request body for this network should contain a symbolic name for the network. Description: This operation asynchronously creates a Layer-2 network in Quantum based on the information provided in the request body. Quantum validates the request, creates the network object, dispatches it to the plugin, and then returns the unique identifier of the network to the caller, who can check the progress of the operation performing a GET on networks/id. Resources for the new network can be either provided at create time or when virtual interfaces are plugged into this network depending on the particular plugin implementation. If the validation phase fails, the network object is not created at all, and a 400 error is returned to the caller. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit

<<Anchor(PutNetwork)>>

4.Update Network

Verb	URI
PUT	/networks/id

Request Body: The request body for this operation will possibly contain the new symbolic name for the network. Description: This operation asynchronously updates a network in Quantum according to the information provided in the request body. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 510 PluginFault

<<Anchor(DeleteNetwork)>>

5.Delete Network

Verb	URI
DELETE	/networks/id

Request Body: This operation does not require a request body. Description: This operation removes the network specified in the URI. It will fail if an attachment is plugged into anyone of the network’s ports (error code 511). It will not fail instead if logical ports are configured for the network, as long as nothing is plugged into them. Logical ports will be destroyed together with the network. The operation is asynchronous. Quantum forwards it to the plugin, and upon success removes the network object. Callers can check the current status of the operation by performing a GET on networks/id. This operation is not recoverable. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 510 PluginFault, 511 AttachmentsPlugged

<<Anchor(GetPorts)>>

6.List logical ports for network

Verb	URI
GET	/networks/id/ports

Request Body: This operation does not require a request body. Description: This operation lists all the ports currently configured for a network. Response should include, for each port, at least its unique identifier (might just be a port number) and the identifier of the attachment plugged into it, if any. Response Codes: Normal Response code: 200 Error response code(s): 500 Service Unavailable, 401 Unauthorized

<<Anchor(GetPortDetails)>>

7.List port details

Verb	URI
GET	networks/net_id/ports/port_id

Request Body: This operation does not require a request body. Description: This operation provides detailed output for a specific port configured for a given network. This operation will return all the attributes of the port, including plugin-specific attributes. Response Codes: Normal Response code: 200 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized

<<Anchor(PostPort)>>

8.Create Port

Verb	URI
POST	/networks/id/ports

Request Body: The request body is not mandatory. Description: This operation asynchronously creates a port on a Quantum network based on the information provided in the request body. Quantum validates the request, creates the port object and attaches it to the appropriate network object. The request is then dispatched to the plugin. Resources for the new port can be either provided at create time or when virtual interfaces are plugged into this port depending on the particular plugin implementation. Also, this operation could not be implemented for some plugins as the number of ports available might be fixed when the network is created. If the validation phase fails, the port object is not created at all, and a 400 error is returned to the caller. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit

<<Anchor(DeletePort)>>

9.Delete Port

Verb	URI
DELETE	/networks/net_id/ports/port_id

Request Body: This operation does not require a request body. Description: This operation removes a logical port from a Quantum network. This operation might not be available for plugins in which the number of ports is fixed at network creation; in this case ports should not be deleted, just as they cannot be created. The operation is not recoverable and will fail if an attachment is plugged into the port. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 510 PluginFault, 511 AttachmentsPlugged.

<<Anchor(GetPortAttachment)>>

10.List attachment details for port

Verb	URI
GET	/networks/net_id/ports/port_id/attachment

Request Body: This operation does not require a request body. Description: This operation returns configuration details for the attachment plugged into the port specified in the request URI. This information might include: - Type of the attachment (e.g.: virtual network interface, bridge device); - A reference to the resource being attached (If managed by Quantum); - A reference to an external resource being attached (If not managed by Quantum); Response Codes: Normal Response code: 200 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorize

<<Anchor(PutPortAttachment)>>

11.Attach resource to port

Verb	URI
PUT	/networks/net_id/ports/port_id/attachment

Request Body: The request body for this network should contain a reference to the resource to plug into the logical port. Plugged resources can either be managed by or external to Quantum. In both cases, the request body will contain an identifier for that resource. Description: This operation asynchronously plugs a resource, or attachment, into the logical port specified in the request URL. A resource could be either a virtual network interface belonging to a VM instance, a bridging device used to extend the Quantum network in a different data centre, or any kind of device which might be plugged into the Quantum network in order to provide different services, such as IP addressing management. Different kinds of resources can be defined in the future. The request will be first validated by Quantum and then dispatched to the plugin. As the request is asynchronous, control is immediately returned to the caller. Progress of the operation can then be checked by querying the attachment (or the logical port) with a GET request. The validation can fail if: - The attachment is already plugged somewhere else; - There is already another attachment plugged into the specified logical port. If the validation phase fails, the attachment object is not created at all, and a 400 error is returned to the caller. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit, 423 AlreadyAttached, 423 PortInUse, 510 PluginFault

<<Anchor(DeletePortAttachment)>>

12.Remove attachment from port

Verb	URI
DELETE	/networks/net_id/ports/port_id/attachment

Request Body: This operation does not require a request body. Description: This operation asynchronously removes an attachment from a logical port. This operation cannot be undone. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit, 510 PluginFault

<<Anchor(GetNetworkAttachments)>>

13.Retrieve resources attached to network

Verb	URI
GET	/networks/net_id/attachments

Request Body: This operation does not require a request body. Description: This operation return a list of resource currently attached to the virtual network specified in the URI. For each resource, the returned list should specify at least the identifier of the resource and the identifier of the port in which the resource is currently plugged. Response codes: Normal Response code: 200 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized

<<Anchor(PostNetworkAttachment)>>

14.Attach resource to network

Verb	URI
POST	/networks/net_id/attachments

Request Body: The request body for this network should contain a reference to the resource to plug into the logical port. Plugged resources can either be managed by or external to Quantum. In both cases, the request body will contain an identifier for that resource. Description: This operation asynchronously plugs a resource, or attachment, into the logical port specified in the request URL. A resource could be either a virtual network interface belonging to a VM instance, a bridging device used to extend the Quantum network in a different data centre, or any kind of device which might be plugged into the Quantum network in order to provide different services, such as IP addressing management. Different kinds of resources can be defined in the future. This operation is very similar to “attach resource to port”, with the only exception that a logical port is not specified in this case. Quantum plugins can either use a free port on the network, or create a new logical port, and then plug the resource into it. The identifier of the logical port where the resource has been plugged should be returned to the caller. Response Codes: Normal Response code: 202 Error response code(s): 500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit, 423 AlreadyAttached, 424 PortInUse, 510 PluginFault

@@ Line 5: / Line 5: @@
 == Introduction ==
-This document constitutes a first attempt in defining an API for the Quantum service. The operation list cannot be deemed complete, and formats for request and response messages have not yet been defined. Moreover, authentication, authorization, and extension mechanisms, as well as the URL structure, are not defined in this document.
+~-This document constitutes a first attempt in defining an API for the Quantum service. The operation list cannot be deemed complete, and formats for request and response messages have not yet been defined. Moreover, authentication, authorization, and extension mechanisms, as well as the URL structure, are not defined in this document.
 Since Quantum provides “network connectivity as a service”, this API defines Layer-2 operations only. This document also proposes operations for bridging Quantum networks with external networks, such as a customer-managed network in an on-premise data centre; however, use cases in this area (bridging and federation) should be explored better.
-We first introduce the operation list, and then discuss how these operations can be used to accomplish some common use cases.
+We first introduce the operation list, and then discuss how these operations can be used to accomplish some common use cases.-~
 == Glossary ==
@@ Line 27: / Line 27: @@
 == Operation List ==
-<span id="Op1"></span><<Anchor([[ListNetworks]])>> === 1.List networks ===
+<span id="op1"></span><<Anchor([[GetNetworks]])>>
+=== 1.List networks ===
+~-
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| GET
+| /networks
+|}
+''Request Body:''
-Verb	URI	Description
-GET	/networks	List summary of networks configured in Quantum
-Request Body:
 This operation does not require a request body.
-Description:
+''Description:''
 This operation returns the list of all networks currently defined in Quantum; returned list includes at least the network’s unique identifier.
-Response Codes:
+''Response Codes:''
 Normal Response code: 200
 Error response code(s):  500 Service Unavailable, 401 Unauthorized
-.	List network details
+-~
-Verb	URI	Description
-GET	/networks/id	List details of network identified by id
+<span id="op2"></span><<Anchor([[GetNetworkDetails]])>>
+=== 2.List network details ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| GET
+| /networks/id
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 48: / Line 70: @@
 Normal Response code: 200
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized
-.	Create Network
-Verb	URI	Description
+<span id="op3"></span><<Anchor([[PostNetwork]])>>
-POST	/networks	Create a new network
+=== 3.Create Network ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| POST
+| /networks
+|}
 Request Body:
 The request body for this network should contain a symbolic name for the network.
@@ Line 61: / Line 91: @@
 Normal Response code: 202
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit
-.	Update Network
-Verb	URI	Description
+<span id="op4"></span><<Anchor([[PutNetwork]])>>
-PUT	/networks/id	Changes the configuration of the network identified by id
+=== 4.Update Network ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| PUT
+| /networks/id
+|}
 Request Body:
 The request body for this operation will possibly contain the new symbolic name for the network.
@@ Line 71: / Line 110: @@
 Normal Response code: 202
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 510 [[PluginFault]]
-.	Delete Network
-Verb	URI	Description
+<span id="op5"></span><<Anchor([[DeleteNetwork]])>>
-DELETE	/networks/id	Removes the network identified by id
+=== 5.Delete Network ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| DELETE
+| /networks/id
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 84: / Line 132: @@
 Normal Response code: 202
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 510 [[PluginFault]], 511 [[AttachmentsPlugged]]
-.	List logical ports for network
-Verb	URI	Description
+<span id="op6"></span><<Anchor([[GetPorts]])>>
-GET	/networks/id/ports	Lists all the ports currently defined for a Quantum network
+=== 6.List logical ports for network ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| GET
+| /networks/id/ports
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 94: / Line 151: @@
 Normal Response code: 200
 Error response code(s):  500 Service Unavailable, 401 Unauthorized
-.	List port details
-Verb	URI	Description
+<span id="op7"></span><<Anchor([[GetPortDetails]])>>
-GET	networks/net_id/ports/port_id	Retrieves detail of the port port_id configured for the network net_id.
+=== 7.List port details ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| GET
+| networks/net_id/ports/port_id
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 105: / Line 171: @@
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized
-.	Create Port
+<span id="op8"></span><<Anchor([[PostPort]])>>
-Verb	URI	Description
+=== 8.Create Port ===
-POST	/networks/id/ports	Creates a logical port on the network specified in the request URI
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| POST
+| /networks/id/ports
+|}
 Request Body:
 The request body is not mandatory.
@@ Line 118: / Line 192: @@
 Normal Response code: 202
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit
-.	Delete logical port
-Verb	URI	Description
+<span id="op9"></span><<Anchor([[DeletePort]])>>
-DELETE	/networks/net_id/ports/port_id	Removes a port from the logical
+=== 9.Delete Port ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| DELETE
+| /networks/net_id/ports/port_id
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 131: / Line 214: @@
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 510 [[PluginFault]], 511 [[AttachmentsPlugged]].
-.	List attachment details for port
+<span id="op10"></span><<Anchor([[GetPortAttachment]])>>
-Verb	URI	Description
+=== 10.List attachment details for port ===
-GET	/networks/net_id/ports/port_id/attachment	Lists complete information about the attachment currently plugged into the specified port
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| GET
+| /networks/net_id/ports/port_id/attachment
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 143: / Line 234: @@
 Response Codes:
 Normal Response code: 200
-Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized
+Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorize
-.	Attach resource to port
-Verb	URI	Description
+<span id="op11"></span><<Anchor([[PutPortAttachment]])>>
-PUT	/networks/net_id/ports/port_id/attachment	Plugs a resource (e.g.: virtual network interface, bridging device) into a logical port on a virtual network
+=== 11.Attach resource to port ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| PUT
+| /networks/net_id/ports/port_id/attachment
+|}
 Request Body:
 The request body for this network should contain a reference to the resource to plug into the logical port.
@@ Line 161: / Line 261: @@
 Normal Response code: 202
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit, 423 [[AlreadyAttached]], 423 [[PortInUse]], 510 [[PluginFault]]
-.	Remove attachment from port
-Verb	URI	Description
+<span id="op12"></span><<Anchor([[DeletePortAttachment]])>>
-DELETE	/networks/net_id/ports/port_id/attachment	Removes the currently attached resource
+=== 12.Remove attachment from port ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| DELETE
+| /networks/net_id/ports/port_id/attachment
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 172: / Line 281: @@
 Normal Response code: 202
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized, 413 Over Limit, 510 [[PluginFault]]
-.	Retrieve resource attached to network
-Verb	URI	Description
+<span id="op13"></span><<Anchor([[GetNetworkAttachments]])>>
-GET	/networks/net_id/attachments	Retrieve all the resources (e.g.: virtual network interface, bridging device) currently attached to a network
+=== 13.Retrieve resources attached to network ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| GET
+| /networks/net_id/attachments
+|}
 Request Body:
 This operation does not require a request body.
@@ Line 182: / Line 300: @@
 Normal Response code: 200
 Error response code(s):  500 Service Unavailable, 400 Bad Request, 401 Unauthorized
-.	Attach resource to network
-Verb	URI	Description
+<span id="op14"></span><<Anchor([[PostNetworkAttachment]])>>
-POST	/networks/net_id/attachments	Plugs a resource (e.g.: virtual network interface, bridging device) into the specified network, without specifying a logical port
+=== 14.Attach resource to network ===
+{| border="1" cellpadding="2" cellspacing="0"
+| Verb
+| URI
+|-
+| POST
+| /networks/net_id/attachments
+|}
 Request Body:
 The request body for this network should contain a reference to the resource to plug into the logical port.