This shows you the differences between two versions of the page.
nova-rdp-api [2014/05/07 02:28] admin [Get console connection info: V2 API] |
nova-rdp-api [2014/05/07 02:28] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Nova RDP Support API====== | ||
- | |||
- | Nova currently provides support for [[http:// | ||
- | |||
- | [[http:// | ||
- | |||
- | |||
- | ---- | ||
- | ===== Getting an RDP console URL ===== | ||
- | |||
- | This requires a public API which is symmetric with the VNC and SPICE ones. | ||
- | |||
- | |||
- | ==== Get an RDP console URL: V2 API ==== | ||
- | |||
- | ^Verb ^URI ^Description ^ | ||
- | |GET |/ | ||
- | |||
- | Normal Response Code(s): 200 | ||
- | |||
- | Error Response Code(s): badRequest (400), itemNotFound (404), buildInProgress (409) | ||
- | |||
- | |||
- | === Example. Get RDP console URL request: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL request: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL response: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=' | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL response: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ---- | ||
- | |||
- | ==== Get an RDP console URL: V3 API ==== | ||
- | |||
- | ^Verb ^URI ^Description ^ | ||
- | |GET |/ | ||
- | |||
- | Normal Response Code(s): 200 | ||
- | |||
- | Error Response Code(s): badRequest (400), itemNotFound (404), buildInProgress (409) | ||
- | |||
- | === Example. Get RDP console URL request: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL request: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL response: XML === | ||
- | |||
- | Same output as in the [[nova-rdp-api# | ||
- | |||
- | === Example. Get RDP console URL response: JSON === | ||
- | |||
- | Same output as in the [[nova-rdp-api# | ||
- | |||
- | ---- | ||
- | |||
- | ===== Getting console connection details ===== | ||
- | |||
- | Nova includes internally the required proxy solutions for VNC (novnc, xvpvnc) and SPICE, but this is not the case for RDP. Beside that, it's also desirable to leave to third party the ability to choose a custom graphical console UI solution not necessarily included with Nova. A public API has been provided to retrieve the relevant information by providing a valid console authentication token. | ||
- | |||
- | ==== Get console connection info: V2 API ==== | ||
- | |||
- | ^Verb ^URI ^Description ^ | ||
- | |GET |/ | ||
- | |||
- | Normal Response Code(s): 200 | ||
- | |||
- | Error Response Code(s): badRequest (400), itemNotFound (404) | ||
- | |||
- | |||
- | === Example. Get console connection request: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | </ | ||
- | |||
- | === Example. Get console connection request: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | } | ||
- | </ | ||
- | |||
- | === Example. Get console connection response: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=' | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
- | |||
- | === Example. Get console connection response: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ---- | ||
- | |||
- | ==== Get console connection info: V3 API ==== | ||
- | |||
- | ^Verb ^URI ^Description ^ | ||
- | |GET |/ | ||
- | |||
- | Normal Response Code(s): 200 | ||
- | |||
- | Error Response Code(s): badRequest (400), itemNotFound (404) | ||
- | |||
- | === Example. Get console connection request: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | </ | ||
- | |||
- | === Example. Get console connection request: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | } | ||
- | </ | ||
- | |||
- | === Example. Get console connection response: XML === | ||
- | |||
- | Same output as in the [[nova-rdp-api# | ||
- | |||
- | === Example. Get console connection response: JSON === | ||
- | |||
- | Same output as in the [[nova-rdp-api# | ||