resource_DeployController.html 46.4 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api: DeployController</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api: DeployController</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li><a href="#resource_DeployController_deleteAll_DELETE">DELETE /user/v1.0/deployer/all</a></li>
          <li><a href="#resource_DeployController_deploy_POST"><abbr title="POST /user/v1.0/deployer/deploy">POST /user/v1.0/deployer/deplo...</abbr></a></li>
          <li><a href="#resource_DeployController_getIds_GET">GET /user/v1.0/deployer/ids</a></li>
          <li><a href="#resource_DeployController_sample_GET">GET /user/v1.0/deployer/sample</a></li>
58
          <li><a href="#resource_DeployController_scaleDeployment_POST">POST /user/v1.0/deployer/scale</a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
59 60
          <li><a href="#resource_DeployController_delete_DELETE"><abbr title="DELETE /user/v1.0/deployer/{id}">DELETE /user/v1.0/deployer/{id...</abbr></a></li>
          <li><a href="#resource_DeployController_get_GET">GET /user/v1.0/deployer/{id}</a></li>
61 62
          <li><a href="#resource_DeployController_getContainerStatus_GET"><abbr title="GET /user/v1.0/deployer/{id}/container_status">GET /user/v1.0/deployer/{id}/c...</abbr></a></li>
          <li><a href="#resource_DeployController_getContainerStatus_GET"><abbr title="GET /user/v1.0/deployer/{id}/service_names">GET /user/v1.0/deployer/{id}/s...</abbr></a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
          <li class="divider"></li>
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="resources.html">Resources</a></li>
          <li class="dropdown"><a href="resource_DeployController.html">DeployController</a></li>
        </ol>

      <h1 class="page-header">DeployController <small>Resource</small></h1>

      <p>This controller is responsible for deploying a cluster on provisoned
resources.</p>

      <div id="resource_DeployController_deleteAll_DELETE">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
81
        <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/all <a href="./user/v1.0/deployer/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
82

Spiros Koulouzis's avatar
Spiros Koulouzis committed
83
        <p>Deletes all entries. Use with caution !</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99 100 101 102
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful delete</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
DELETE /user/v1.0/deployer/all
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
146
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
147 148 149 150 151 152 153 154 155 156 157 158
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_DeployController_deploy_POST">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
159
        <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/deployer/deploy <a href="./user/v1.0/deployer/deploy" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
160

Spiros Koulouzis's avatar
Spiros Koulouzis committed
161
        <p>Deploys software (inc. swarm ,kubernetes) to provisioned VMs.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-request-body">
          <caption>Request Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_DeployRequest.html">DeployRequest</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_deployRequest.html">deployRequest</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
          <tr>
            <td><span class="label label-warning response-code">400</span></td>
            <td><span class="response-condition">Empty manager type. Aveliable: ansible, swarm ,kubernetes</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">400</span></td>
            <td><span class="response-condition">Empty provision ID</span></td>
          </tr>
          <tr>
            <td><span class="label label-danger response-code">500</span></td>
            <td><span class="response-condition">Deploymet failed</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful deploymet</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
POST /user/v1.0/deployer/deploy
Content-Type: application/json
Accept: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
256
  &quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
257 258
  &quot;managerType&quot; : &quot;ansible&quot;,
  &quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
259
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
260
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
261
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
262 263 264 265 266 267 268
}
                </code>
              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
269
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
270 271 272 273 274 275 276 277 278 279 280 281
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_DeployController_getIds_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
282
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ids <a href="./user/v1.0/deployer/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
283

Spiros Koulouzis's avatar
Spiros Koulouzis committed
284
        <p>Gets the IDs of all the stored deployment descriptions.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
300 301 302 303
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful query</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
304 305 306 307 308 309 310 311 312 313 314 315 316
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
317
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
318 319 320 321 322 323 324
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">array of string
 (JSON)</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
325
            <td rowspan="2" class="multi-row-description"><span class="response-description">a list of all the IDs</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">list of string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/ids
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_DeployController_sample_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
362
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/sample <a href="./user/v1.0/deployer/sample" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

        <p></p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_DeployRequest.html">DeployRequest</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_deployRequest.html">deployRequest</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/sample
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
428
  &quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
429 430
  &quot;managerType&quot; : &quot;ansible&quot;,
  &quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
431
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
432
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
433
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
434 435 436 437 438 439 440 441
}
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

442 443 444
      <div id="resource_DeployController_scaleDeployment_POST">
        <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/deployer/scale <a href="./user/v1.0/deployer/scale" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>

445
        <p>Scales deployment</p>
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-request-body">
          <caption>Request Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
463
            <td><span class="datatype-reference"><a href="json_ScaleRequest.html">ScaleRequest</a>
464 465 466 467
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
468
            <td><span class="datatype-reference"><a href="xml_ns0_scaleRequest.html">scaleRequest</a>
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
 (XML)</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
POST /user/v1.0/deployer/scale
Content-Type: application/json
Accept: application/json

                <code class="prettyprint language-js">
{
524 525
  &quot;scaleTargetID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
  &quot;scaleTargetName&quot; : &quot;telegreen_db&quot;,
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
  &quot;numOfInstances&quot; : 5,
  &quot;owner&quot; : &quot;user1&quot;,
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
  &quot;timestamp&quot; : 1499793079011
}
                </code>
              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 201 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
549
      <div id="resource_DeployController_delete_DELETE">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
550
        <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/{id} <a href="./user/v1.0/deployer/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
551

Spiros Koulouzis's avatar
Spiros Koulouzis committed
552
        <p>Deletes entry</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
553 554 555 556 557 558 559 560 561 562 563 564 565

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
566
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
567 568 569 570 571 572 573
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
574
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
575 576 577 578 579 580 581 582 583 584 585 586 587
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
588 589 590 591 592 593 594 595
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful delete</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Object not found</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
DELETE /user/v1.0/deployer/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
639
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
640 641 642 643 644 645 646 647 648 649 650 651
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_DeployController_get_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
652
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/{id} <a href="./user/v1.0/deployer/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
653

Spiros Koulouzis's avatar
Spiros Koulouzis committed
654
        <p>Returns a deployment description</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
655 656 657 658 659 660 661 662 663 664 665 666 667

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
668
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
669 670 671 672 673 674 675
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
676
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
677 678 679 680 681 682 683 684 685 686 687 688 689
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
690 691 692 693 694 695
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Object not found</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
696
            <td><span class="response-condition">Object found</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
697
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_DeployResponse.html">DeployResponse</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_deployResponse.html">deployResponse</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
746
  &quot;ansibleOutputList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
747
  &quot;keyPair&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
748
    &quot;privateKey&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
749 750
      &quot;name&quot; : &quot;id_dsa.pub&quot;,
      &quot;type&quot; : &quot;PRIVATE&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
751 752 753
      &quot;attributes&quot; : {
        &quot;property1&quot; : &quot;domain_name:Virginia&quot;,
        &quot;property2&quot; : &quot;domain_name:Virginia&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
754
      },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
755
      &quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
756
    },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
757
    &quot;publicKey&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
758 759
      &quot;name&quot; : &quot;id_dsa.pub&quot;,
      &quot;type&quot; : &quot;PRIVATE&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
760 761 762
      &quot;attributes&quot; : {
        &quot;property1&quot; : &quot;domain_name:Virginia&quot;,
        &quot;property2&quot; : &quot;domain_name:Virginia&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
763
      },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
764
      &quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
765
    },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
766
    &quot;keyPairId&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
767
    &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
768
    &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
769 770 771
    &quot;timestamp&quot; : 1499793079011
  },
  &quot;scale&quot; : {
772 773
    &quot;scaleTargetID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;scaleTargetName&quot; : &quot;telegreen_db&quot;,
774 775 776 777
    &quot;numOfInstances&quot; : 5,
    &quot;owner&quot; : &quot;user1&quot;,
    &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
778
  },
779 780 781 782
  &quot;managerInfo&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
783
  &quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
784 785
  &quot;managerType&quot; : &quot;ansible&quot;,
  &quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
786
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
787
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
788
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
789 790 791 792 793 794 795 796
}
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
      <div id="resource_DeployController_getContainerStatus_GET">
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/{id}/container_status <a href="./user/v1.0/deployer/{id}/container_status" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>

        <p>For a given service name returns the container status on all nodes</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
            <th>constraints</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
            <td><span class="parameter-constraints">required</span></td>
          </tr>
          <tr>
            <td><span class="parameter-name">service_name</span></td>
            <td>query</td>
            <td><span class="parameter-description">&nbsp;</span></td>
            <td><span class="parameter-constraints">required</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Object not found</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Object found</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_DeployResponse.html">DeployResponse</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_deployResponse.html">deployResponse</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/{id}/container_status
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
{
  &quot;ansibleOutputList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
  &quot;keyPair&quot; : {
    &quot;privateKey&quot; : {
      &quot;name&quot; : &quot;id_dsa.pub&quot;,
      &quot;type&quot; : &quot;PRIVATE&quot;,
      &quot;attributes&quot; : {
        &quot;property1&quot; : &quot;domain_name:Virginia&quot;,
        &quot;property2&quot; : &quot;domain_name:Virginia&quot;
      },
      &quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;
    },
    &quot;publicKey&quot; : {
      &quot;name&quot; : &quot;id_dsa.pub&quot;,
      &quot;type&quot; : &quot;PRIVATE&quot;,
      &quot;attributes&quot; : {
        &quot;property1&quot; : &quot;domain_name:Virginia&quot;,
        &quot;property2&quot; : &quot;domain_name:Virginia&quot;
      },
      &quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;
    },
    &quot;keyPairId&quot; : &quot;...&quot;,
    &quot;owner&quot; : &quot;user1&quot;,
    &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;timestamp&quot; : 1499793079011
  },
  &quot;scale&quot; : {
    &quot;scaleTargetID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;scaleTargetName&quot; : &quot;telegreen_db&quot;,
    &quot;numOfInstances&quot; : 5,
    &quot;owner&quot; : &quot;user1&quot;,
    &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;timestamp&quot; : 1499793079011
  },
  &quot;managerInfo&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
  &quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
  &quot;managerType&quot; : &quot;ansible&quot;,
  &quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
  &quot;owner&quot; : &quot;user1&quot;,
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
  &quot;timestamp&quot; : 1499793079011
}
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_DeployController_getContainerStatus_GET">
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/{id}/service_names <a href="./user/v1.0/deployer/{id}/service_names" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>

        <p>Returns the service names running on the cluster</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
            <th>constraints</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
            <td><span class="parameter-constraints">required</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Object not found</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Object found</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">array of string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">list of string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/{id}/service_names
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>