From 48b670d043f190ae5c23f7d55860dcac1393a17d Mon Sep 17 00:00:00 2001 From: Serg Melikyan Date: Mon, 8 Apr 2013 10:25:51 +0400 Subject: [PATCH] Finished converting API Specification --- .../src/docbkx/glazier-manual.xml | 1473 ++++++++++++++++- 1 file changed, 1469 insertions(+), 4 deletions(-) diff --git a/docs/src/glazier-manual/src/docbkx/glazier-manual.xml b/docs/src/glazier-manual/src/docbkx/glazier-manual.xml index 99949364..042a2572 100644 --- a/docs/src/glazier-manual/src/docbkx/glazier-manual.xml +++ b/docs/src/glazier-manual/src/docbkx/glazier-manual.xml @@ -349,7 +349,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst id - GUID + guid Unique ID @@ -369,7 +369,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst tenant_id - GUID + guid Open Stack tenant id @@ -385,7 +385,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
Call - + GET /environments Call @@ -413,7 +413,7 @@ http://docbook.org/ns/docbook " xmlns:xsi="http://www.w3.org/2001/XMLSchema-inst
Returns - This call returns list of environments. Only the basic properties are returned. For details see “Get Environment Detailed Information”: + This call returns list of environments. Only the basic properties are returned. For details see "Get Environment Detailed Information":
+
+ Create Environment instance +
+ Call +
+ POST /environments Call + + + + + + + Method + URI + Description + + + + + POST + /environments + Create new Environment + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created environment: + + + + +
+ +
+ Update Environment Instance +
+ Call + + PUT /environments/<id> Call + + + + + + + Method + URI + Description + + + + + PUT + /environments/<id> + Update properties of Environment instance + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns modified environment object: + + + + +
+
+
+ Get Environment Instance Detailed Information +
+ Call + + GET /environments/<id> Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id> + Returns detailed information about Environment including child entities + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns modified environment object: + + + + +
+
+
+ Remove Environment +
+ Call + + DELETE /environments/<id> Call + + + + + + + Method + URI + Description + + + + + DELETE + /environments/<id> + Remove specified Environment. + + + +
+
+
+ Payload + None +
+
+ Returns + None +
+
+ +
+ Environment Configuration API + Only one Environment can be configured at a time by only one user. This behavior archived by opening "configuration session" for some Environment by user, and locking this Environment for changes by other users. Only one open session per Environment is available. + + Configuration Session Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Session unique ID + + + environment_id + guid + Environment that going to be modified during this session + + + created + datetime + Creation date and time in ISO format + + + updated + datetime + Modification date and time in ISO format + + + user_id + guid + Session owner guid + + + state + string + Session state. Could be: open, deploying, deployed + + + +
+
+ Get a List of Sessions + Only one open session can be for one Environment. +
+ Call + + GET /environments/<id>/sessions Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/sessions + Get a list of open sessions + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of open sessions: + + + + +
+
+
+ Open session + During this call new working session is created, and session ID should be sent in header (X-Configuration-Session) to all next API calls. +
+ Call + + POST /environments/<id>/configure Call + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/configure + Creating new configuration change session + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns created session: + + + + +
+
+
+ Deploy changes from Session +
+ Call + + POST /environments/<id>/sessions/<sessionId>/deploy Call + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/sessions/<sessionId>/deploy + Deploying changes made in session with specified <sessionId> + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns deployed session: + + + + +
+
+
+ Get session information +
+ Call + + GET /environments/<id>/sessions/<sessionId> Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/sessions/<sessionId> + Getting details about session with specified <sessionId> + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns session information: + + + + +
+
+
+ Delete Session +
+ Call + + DELETE /environments/<id>/sessions/<sessionId> Call + + + + + + + Method + URI + Description + + + + + DELETE + /environments/<id>/sessions/<sessionId> + Delete session with specified <sessionId> + + + +
+
+
+ Payload + None +
+
+ Returns + None +
+
+
+
+ Active Directory API + This section describes API calls for Active Directory service management. +
+ Get a List of existing Active Directory instances + + Active Directory Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + name + string + Domain name + + + created + datetime + Creation date and time in ISO format + + + updated + datetime + Modification date and time in ISO format + + + configuration + string + AD configuration: site, standalone, inTree + + + domain + string + Domain name (same as name) + + + units + object + Active Directory Unit object + + + +
+ + Active Directory Unit Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + isMaster + boolean + Is unit is master domain? + + + location + string + AvailabilityZone or specific physical datacenter. + + + +
+
+ Call + + GET /environments/<id>/activeDirectories Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/activeDirectories + Get a list of Active Directory instances + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of Active Directory instances: + + + + +
+
+
+ Create Active Directory instance + + Active Directory Object + + + + + + + Attribute + Type + Description + + + + + name + string + Domain name + + + configuration + string + AD configuration: site, standalone, inTree + + + adminPassword + string + Password from domain administrator account + + + domain + string + Domain name (same as name) + + + units + object + Active Directory Unit object + + + +
+ + Active Directory Unit Object + + + + + + + Attribute + Type + Description + + + + + isMaster + boolean + Is unit is master domain? + + + recoveryPassword + string + Recovery password + + + location + string + AvailabilityZone or specific physical datacenter. + + + +
+
+ Call + + POST /environments/<id>/activeDirectories Call + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/activeDirectories + Create new Active Directory + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created active directory domain: + + + + +
+
+
+ Update Active Directory instance + + Active Directory Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + name + string + Domain name + + + configuration + string + AD configuration: site, standalone, inTree + + + adminPassword + string + Password from domain administrator account + + + domain + string + Domain name (same as name) + + + units + object + Active Directory Unit object + + + +
+ + Active Directory Unit Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + isMaster + boolean + Is unit is master domain? + + + recoveryPassword + string + Recovery password + + + location + string + AvailabilityZone or specific physical datacenter. + + + +
+
+ Call + + PUT /environments/<id>/activeDirectories/<serviceId> Call + + + + + + + Method + URI + Description + + + + + PUT + /environments/<id>/activeDirectories/<serviceId> + Update existing Active Directory + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns updated active directory domain: + + + + +
+
+
+ Get Information about Active Directory instance + + Active Directory Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + name + string + Domain name + + + created + datetime + Creation date and time in ISO format + + + updated + datetime + Modification date and time in ISO format + + + configuration + string + AD configuration: site, standalone, inTree + + + domain + string + Domain name (same as name) + + + units + object + Active Directory Unit object + + + +
+ + Active Directory Unit Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + isMaster + boolean + Is unit is master domain? + + + location + string + AvailabilityZone or specific physical datacenter. + + + +
+
+ Call + + GET /environments/<id>/activeDirectories/<serviceId> Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/activeDirectories/<serviceId> + Return specified Active Directory instance + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns modified environment object: + + + + +
+
+
+
+ Web Server API + This section describes API calls for managing Windows web-server software – IIS. + + Web Server Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + name + string + User-friendly name + + + created + datetime + Creation date and time in ISO format + + + updated + datetime + Modification date and time in ISO format + + + domain + string + Domain name (same as name) + + + units + object + Web Server Unit object + + + +
+ + Web Server Unit Object + + + + + + + Attribute + Type + Description + + + + + id + guid + Unique ID + + + endpoint + object + Unit Endpoint + + + location + string + AvailabilityZone or specific physical datacenter. + + + +
+ + Web Server Unit Endpoint Object + + + + + + + Attribute + Type + Description + + + + + host + string + Host address for IIS Management Console connection + + + +
+
+ Get a List of existing Web Servers +
+ Call + + GET /environments/<id>/webServers Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/webServers + Get a list of existing Web Servers + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of web servers: + + + + +
+
+
+ Create Web Server instance +
+ Call + + POST /environments/<id>/webServers Call + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/webServers + Create new Web Server + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created web server: + + + + +
+
+
+ Update Web Server Instance +
+ Call + + PUT /environments/<id>/webServers/<serviceId> Call + + + + + + + Method + URI + Description + + + + + PUT + /environments/<id>/webServers/<serviceId> + Update properties of WebServer instance + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns modified web server object: + + + + +
+
+
+ Get Web Server Instance Detailed Information +
+ Call + + GET /environments/<id>/webServers/<serviceId> Call + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/webServers/<serviceId> + Returns detailed information about Web Server + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns modified environment object: + + + + +
+