Jump to: navigation, search

Difference between revisions of "QuantumAPISpec"

Line 6: Line 6:
 
== Introduction ==
 
== 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.  
 
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 ==
 
== Glossary ==

Revision as of 15:58, 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