| 1 |
.. -*- rst -*- |
| 2 |
|
| 3 |
====== |
| 4 |
Leases |
| 5 |
====== |
| 6 |
|
| 7 |
A date and time format for *\*_date* parameters is ``CCYY-MM-DD hh:mm``. |
| 8 |
For example, ``2017-12-26 12:00``. |
| 9 |
|
| 10 |
List Leases |
| 11 |
=========== |
| 12 |
|
| 13 |
.. rest_method:: GET v1/leases |
| 14 |
|
| 15 |
List leases. |
| 16 |
|
| 17 |
**Response codes** |
| 18 |
|
| 19 |
Normal response code: 200 |
| 20 |
|
| 21 |
Error response codes: Bad Request(400), Unauthorized(401), Forbidden(403), |
| 22 |
Internal Server Error(500) |
| 23 |
|
| 24 |
Request |
| 25 |
------- |
| 26 |
|
| 27 |
No body content, path, nor query option. |
| 28 |
|
| 29 |
Response |
| 30 |
-------- |
| 31 |
|
| 32 |
General Parameters |
| 33 |
^^^^^^^^^^^^^^^^^^ |
| 34 |
|
| 35 |
.. rest_parameters:: parameters.yaml |
| 36 |
|
| 37 |
- leases: leases |
| 38 |
- id: lease_id |
| 39 |
- name: lease_name |
| 40 |
- start_date: lease_start_date_resp |
| 41 |
- end_date: lease_end_date |
| 42 |
- status: lease_status |
| 43 |
- degraded: lease_degraded |
| 44 |
- user_id: lease_user_id |
| 45 |
- project_id: lease_project_id |
| 46 |
- trust_id: lease_trust_id |
| 47 |
- created_at: created_at |
| 48 |
- updated_at: updated_at |
| 49 |
- reservations: reservations |
| 50 |
- reservation.id: reservation_id |
| 51 |
- reservation.lease_id: reservation_lease_id |
| 52 |
- reservation.status: reservation_status |
| 53 |
- reservation.missing_resources: reservation_missing_resources |
| 54 |
- reservation.resources_changed: reservation_resources_changed |
| 55 |
- reservation.resource_id: reservation_resource_id |
| 56 |
- reservation.resource_type: reservation_resource_type |
| 57 |
- reservation.created_at: created_at |
| 58 |
- reservation.updated_at: updated_at |
| 59 |
- events: events |
| 60 |
- event.id: event_id |
| 61 |
- event.lease_id: event_lease_id |
| 62 |
- event.status: event_status |
| 63 |
- event.event_type: event_type |
| 64 |
- event.time: event_time |
| 65 |
- event.created_at: created_at |
| 66 |
- event_updated_at: updated_at |
| 67 |
|
| 68 |
Parameters for Host Reservation |
| 69 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 70 |
|
| 71 |
The following parameters are returned for host reservation. All parameters |
| 72 |
are in the ``reservation`` object. |
| 73 |
|
| 74 |
.. rest_parameters:: parameters.yaml |
| 75 |
|
| 76 |
- reservation.min: reservation_min |
| 77 |
- reservation.max: reservation_max |
| 78 |
- reservation.hypervisor_properties: reservation_hypervisor_properties |
| 79 |
- reservation.resource_properties: reservation_resource_properties |
| 80 |
- reservation.before_end: reservation_before_end |
| 81 |
|
| 82 |
Parameters for Instance Reservation |
| 83 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 84 |
|
| 85 |
The following parameters are returned for instance reservation. All parameters |
| 86 |
are in the ``reservation`` object. |
| 87 |
|
| 88 |
.. rest_parameters:: parameters.yaml |
| 89 |
|
| 90 |
- reservation.amount: reservation_amount |
| 91 |
- reservation.vcpus: reservation_vcpus |
| 92 |
- reservation.memory_mb: reservation_memory_mb |
| 93 |
- reservation.disk_gb: reservation_disk_gb |
| 94 |
- reservation.affinity : reservation_affinity |
| 95 |
- reservation.resource_properties: reservation_resource_properties |
| 96 |
- reservation.flavor_id: reservation_flavor_id |
| 97 |
- reservation.server_group_id: reservation_server_group_id |
| 98 |
- reservation.aggregate_id: reservation_aggregate_id |
| 99 |
|
| 100 |
Parameters for Flavor-based Instance Reservation |
| 101 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 102 |
|
| 103 |
The following parameters are returned for flavor-based instance reservation. |
| 104 |
All parameters are in the ``reservation`` object. |
| 105 |
|
| 106 |
.. rest_parameters:: parameters.yaml |
| 107 |
|
| 108 |
- reservation.amount: reservation_amount |
| 109 |
- reservation.vcpus: reservation_vcpus |
| 110 |
- reservation.memory_mb: reservation_memory_mb |
| 111 |
- reservation.disk_gb: reservation_disk_gb |
| 112 |
- reservation.affinity : reservation_affinity |
| 113 |
- reservation.resource_properties: reservation_resource_properties |
| 114 |
- reservation.flavor_id: reservation_flavor_id |
| 115 |
- reservation.server_group_id: reservation_server_group_id |
| 116 |
- reservation.aggregate_id: reservation_aggregate_id |
| 117 |
|
| 118 |
**Example of List Leases Response** |
| 119 |
|
| 120 |
.. literalinclude:: ../../../doc/api_samples/leases/lease-list-resp.json |
| 121 |
:language: javascript |
| 122 |
|
| 123 |
Create Lease |
| 124 |
============ |
| 125 |
|
| 126 |
.. rest_method:: POST v1/leases |
| 127 |
|
| 128 |
Create a lease. |
| 129 |
|
| 130 |
**Response codes** |
| 131 |
|
| 132 |
Normal response code: 201 |
| 133 |
|
| 134 |
Error response codes: Bad Request(400), Unauthorized(401), Forbidden(403), |
| 135 |
Conflict(409), Internal Server Error(500) |
| 136 |
|
| 137 |
Request |
| 138 |
------- |
| 139 |
|
| 140 |
General Parameters |
| 141 |
^^^^^^^^^^^^^^^^^^ |
| 142 |
|
| 143 |
.. rest_parameters:: parameters.yaml |
| 144 |
|
| 145 |
- name: lease_name |
| 146 |
- start_date: lease_start_date |
| 147 |
- end_date: lease_end_date |
| 148 |
- before_end_date: lease_before_end_date_optional |
| 149 |
- reservations: reservations |
| 150 |
- reservation.resource_type: reservation_resource_type |
| 151 |
- events: events_optional |
| 152 |
|
| 153 |
Parameters for Host Reservation |
| 154 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 155 |
|
| 156 |
The following parameters are required for host reservation. All parameters |
| 157 |
are in the ``reservation`` object. |
| 158 |
|
| 159 |
.. rest_parameters:: parameters.yaml |
| 160 |
|
| 161 |
- reservation.min: reservation_min |
| 162 |
- reservation.max: reservation_max |
| 163 |
- reservation.hypervisor_properties: reservation_hypervisor_properties |
| 164 |
- reservation.resource_properties: reservation_resource_properties |
| 165 |
- reservation.before_end: reservation_before_end_optional |
| 166 |
|
| 167 |
Parameters for Instance Reservation |
| 168 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 169 |
|
| 170 |
The following parameters are required for instance reservation. All parameters |
| 171 |
are in the ``reservation`` object. |
| 172 |
|
| 173 |
.. rest_parameters:: parameters.yaml |
| 174 |
|
| 175 |
- reservation.amount: reservation_amount |
| 176 |
- reservation.vcpus: reservation_vcpus |
| 177 |
- reservation.memory_mb: reservation_memory_mb |
| 178 |
- reservation.disk_gb: reservation_disk_gb |
| 179 |
- reservation.affinity : reservation_affinity |
| 180 |
- reservation.resource_properties: reservation_resource_properties |
| 181 |
|
| 182 |
Parameters for Flavor-based Instance Reservation |
| 183 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 184 |
|
| 185 |
The following parameters are required for flavor-based instance reservation. |
| 186 |
All parameters are in the ``reservation`` object. |
| 187 |
|
| 188 |
.. rest_parameters:: parameters.yaml |
| 189 |
|
| 190 |
- reservation.amount: reservation_amount |
| 191 |
- reservation.flavor_id: reservation_flavor_id |
| 192 |
- reservation.affinity : reservation_affinity |
| 193 |
- reservation.resource_properties: reservation_resource_properties |
| 194 |
|
| 195 |
**Example of Create Lease Request** |
| 196 |
|
| 197 |
.. literalinclude:: ../../../doc/api_samples/leases/lease-create-req.json |
| 198 |
:language: javascript |
| 199 |
|
| 200 |
Response |
| 201 |
-------- |
| 202 |
|
| 203 |
General Parameters |
| 204 |
^^^^^^^^^^^^^^^^^^ |
| 205 |
|
| 206 |
.. rest_parameters:: parameters.yaml |
| 207 |
|
| 208 |
- lease: lease |
| 209 |
- id: lease_id |
| 210 |
- name: lease_name |
| 211 |
- start_date: lease_start_date_resp |
| 212 |
- end_date: lease_end_date |
| 213 |
- status: lease_status |
| 214 |
- degraded: lease_degraded |
| 215 |
- user_id: lease_user_id |
| 216 |
- project_id: lease_project_id |
| 217 |
- trust_id: lease_trust_id |
| 218 |
- created_at: created_at |
| 219 |
- updated_at: updated_at |
| 220 |
- reservations: reservations |
| 221 |
- reservation.id: reservation_id |
| 222 |
- reservation.lease_id: reservation_lease_id |
| 223 |
- reservation.status: reservation_status |
| 224 |
- reservation.missing_resources: reservation_missing_resources |
| 225 |
- reservation.resources_changed: reservation_resources_changed |
| 226 |
- reservation.resource_id: reservation_resource_id |
| 227 |
- reservation.resource_type: reservation_resource_type |
| 228 |
- reservation.created_at: created_at |
| 229 |
- reservation.updated_at: updated_at |
| 230 |
- events: events |
| 231 |
- event.id: event_id |
| 232 |
- event.lease_id: event_lease_id |
| 233 |
- event.status: event_status |
| 234 |
- event.event_type: event_type |
| 235 |
- event.time: event_time |
| 236 |
- event.created_at: created_at |
| 237 |
- event_updated_at: updated_at |
| 238 |
|
| 239 |
Parameters for Host Reservation |
| 240 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 241 |
|
| 242 |
The following parameters are returned for host reservation. All parameters |
| 243 |
are in the ``reservation`` object. |
| 244 |
|
| 245 |
.. rest_parameters:: parameters.yaml |
| 246 |
|
| 247 |
- reservation.min: reservation_min |
| 248 |
- reservation.max: reservation_max |
| 249 |
- reservation.hypervisor_properties: reservation_hypervisor_properties |
| 250 |
- reservation.resource_properties: reservation_resource_properties |
| 251 |
- reservation.before_end: reservation_before_end |
| 252 |
|
| 253 |
Parameters for Instance Reservation |
| 254 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 255 |
|
| 256 |
The following parameters are returned for instance reservation. All parameters |
| 257 |
are in the ``reservation`` object. |
| 258 |
|
| 259 |
.. rest_parameters:: parameters.yaml |
| 260 |
|
| 261 |
- reservation.amount: reservation_amount |
| 262 |
- reservation.vcpus: reservation_vcpus |
| 263 |
- reservation.memory_mb: reservation_memory_mb |
| 264 |
- reservation.disk_gb: reservation_disk_gb |
| 265 |
- reservation.affinity : reservation_affinity |
| 266 |
- reservation.resource_properties: reservation_resource_properties |
| 267 |
- reservation.flavor_id: reservation_flavor_id |
| 268 |
- reservation.server_group_id: reservation_server_group_id |
| 269 |
- reservation.aggregate_id: reservation_aggregate_id |
| 270 |
|
| 271 |
Parameters for Flavor-based Instance Reservation |
| 272 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 273 |
|
| 274 |
.. rest_parameters:: parameters.yaml |
| 275 |
|
| 276 |
- reservation.amount: reservation_amount |
| 277 |
- reservation.vcpus: reservation_vcpus |
| 278 |
- reservation.memory_mb: reservation_memory_mb |
| 279 |
- reservation.disk_gb: reservation_disk_gb |
| 280 |
- reservation.affinity : reservation_affinity |
| 281 |
- reservation.resource_properties: reservation_resource_properties |
| 282 |
- reservation.flavor_id: reservation_flavor_id |
| 283 |
- reservation.server_group_id: reservation_server_group_id |
| 284 |
- reservation.aggregate_id: reservation_aggregate_id |
| 285 |
|
| 286 |
**Example of Create Lease Response** |
| 287 |
|
| 288 |
.. literalinclude:: ../../../doc/api_samples/leases/lease-create-resp.json |
| 289 |
:language: javascript |
| 290 |
|
| 291 |
Show Lease Details |
| 292 |
================== |
| 293 |
|
| 294 |
.. rest_method:: GET v1/leases/{lease_id} |
| 295 |
|
| 296 |
Show details of a lease. |
| 297 |
|
| 298 |
**Preconditions** |
| 299 |
|
| 300 |
The lease must exist. |
| 301 |
|
| 302 |
**Response codes** |
| 303 |
|
| 304 |
Normal response code: 200 |
| 305 |
|
| 306 |
Error response codes: Bad Request(400), Unauthorized(401), Forbidden(403), |
| 307 |
Not Found(404), Internal Server Error(500) |
| 308 |
|
| 309 |
Request |
| 310 |
------- |
| 311 |
|
| 312 |
.. rest_parameters:: parameters.yaml |
| 313 |
|
| 314 |
- lease_id: lease_id_path |
| 315 |
|
| 316 |
Response |
| 317 |
-------- |
| 318 |
|
| 319 |
General Parameters |
| 320 |
^^^^^^^^^^^^^^^^^^ |
| 321 |
|
| 322 |
.. rest_parameters:: parameters.yaml |
| 323 |
|
| 324 |
- lease: lease |
| 325 |
- id: lease_id |
| 326 |
- name: lease_name |
| 327 |
- start_date: lease_start_date_resp |
| 328 |
- end_date: lease_end_date |
| 329 |
- status: lease_status |
| 330 |
- degraded: lease_degraded |
| 331 |
- user_id: lease_user_id |
| 332 |
- project_id: lease_project_id |
| 333 |
- trust_id: lease_trust_id |
| 334 |
- created_at: created_at |
| 335 |
- updated_at: updated_at |
| 336 |
- reservations: reservations |
| 337 |
- reservation.id: reservation_id |
| 338 |
- reservation.lease_id: reservation_lease_id |
| 339 |
- reservation.status: reservation_status |
| 340 |
- reservation.missing_resources: reservation_missing_resources |
| 341 |
- reservation.resources_changed: reservation_resources_changed |
| 342 |
- reservation.resource_id: reservation_resource_id |
| 343 |
- reservation.resource_type: reservation_resource_type |
| 344 |
- reservation.created_at: created_at |
| 345 |
- reservation.updated_at: updated_at |
| 346 |
- events: events |
| 347 |
- event.id: event_id |
| 348 |
- event.lease_id: event_lease_id |
| 349 |
- event.status: event_status |
| 350 |
- event.event_type: event_type |
| 351 |
- event.time: event_time |
| 352 |
- event.created_at: created_at |
| 353 |
- event_updated_at: updated_at |
| 354 |
|
| 355 |
Parameters for Host Reservation |
| 356 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 357 |
|
| 358 |
The following parameters are returned for host reservation. All parameters |
| 359 |
are in the ``reservation`` object. |
| 360 |
|
| 361 |
.. rest_parameters:: parameters.yaml |
| 362 |
|
| 363 |
- reservation.min: reservation_min |
| 364 |
- reservation.max: reservation_max |
| 365 |
- reservation.hypervisor_properties: reservation_hypervisor_properties |
| 366 |
- reservation.resource_properties: reservation_resource_properties |
| 367 |
- reservation.before_end: reservation_before_end |
| 368 |
|
| 369 |
Parameters for Instance Reservation |
| 370 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 371 |
|
| 372 |
The following parameters are returned for instance reservation. All parameters |
| 373 |
are in the ``reservation`` object. |
| 374 |
|
| 375 |
.. rest_parameters:: parameters.yaml |
| 376 |
|
| 377 |
- reservation.amount: reservation_amount |
| 378 |
- reservation.vcpus: reservation_vcpus |
| 379 |
- reservation.memory_mb: reservation_memory_mb |
| 380 |
- reservation.disk_gb: reservation_disk_gb |
| 381 |
- reservation.affinity : reservation_affinity |
| 382 |
- reservation.resource_properties: reservation_resource_properties |
| 383 |
- reservation.flavor_id: reservation_flavor_id |
| 384 |
- reservation.server_group_id: reservation_server_group_id |
| 385 |
- reservation.aggregate_id: reservation_aggregate_id |
| 386 |
|
| 387 |
Parameters for Flavor-based Instance Reservation |
| 388 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 389 |
|
| 390 |
.. rest_parameters:: parameters.yaml |
| 391 |
|
| 392 |
- reservation.amount: reservation_amount |
| 393 |
- reservation.vcpus: reservation_vcpus |
| 394 |
- reservation.memory_mb: reservation_memory_mb |
| 395 |
- reservation.disk_gb: reservation_disk_gb |
| 396 |
- reservation.affinity : reservation_affinity |
| 397 |
- reservation.resource_properties: reservation_resource_properties |
| 398 |
- reservation.flavor_id: reservation_flavor_id |
| 399 |
- reservation.server_group_id: reservation_server_group_id |
| 400 |
- reservation.aggregate_id: reservation_aggregate_id |
| 401 |
|
| 402 |
**Example of Show Lease Details Response** |
| 403 |
|
| 404 |
.. literalinclude:: ../../../doc/api_samples/leases/lease-details-resp.json |
| 405 |
:language: javascript |
| 406 |
|
| 407 |
Update Lease |
| 408 |
============ |
| 409 |
|
| 410 |
.. rest_method:: PUT v1/leases/{lease_id} |
| 411 |
|
| 412 |
Update a lease. |
| 413 |
|
| 414 |
**Preconditions** |
| 415 |
|
| 416 |
The lease must exist. |
| 417 |
|
| 418 |
**Response codes** |
| 419 |
|
| 420 |
Normal response codes: 200 |
| 421 |
|
| 422 |
Error response codes: Bad Request(400), Unauthorized(401), Forbidden(403), Not Found(404), |
| 423 |
Conflict(409), Internal Server Error(500) |
| 424 |
|
| 425 |
Request |
| 426 |
------- |
| 427 |
|
| 428 |
General Parameters |
| 429 |
^^^^^^^^^^^^^^^^^^ |
| 430 |
|
| 431 |
.. rest_parameters:: parameters.yaml |
| 432 |
|
| 433 |
- lease_id: lease_id_path |
| 434 |
- name: lease_name_optional |
| 435 |
- start_date: lease_start_date_optional |
| 436 |
- end_date: lease_end_date_optional |
| 437 |
- before_end_date: lease_before_end_date_optional |
| 438 |
- reservations: reservations_optional |
| 439 |
- reservation.id: reservation_id |
| 440 |
|
| 441 |
Parameters for Host Reservation |
| 442 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 443 |
|
| 444 |
The following parameters are required for host reservation. All parameters |
| 445 |
are in the ``reservation`` object. |
| 446 |
|
| 447 |
.. rest_parameters:: parameters.yaml |
| 448 |
|
| 449 |
- reservation.min: reservation_min_optional |
| 450 |
- reservation.max: reservation_max_optional |
| 451 |
- reservation.hypervisor_properties: reservation_hypervisor_properties_optional |
| 452 |
- reservation.resource_properties: reservation_resource_properties_optional |
| 453 |
- reservation.before_end: reservation_before_end_optional |
| 454 |
|
| 455 |
Parameters for Instance Reservation |
| 456 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 457 |
|
| 458 |
The following parameters are required for instance reservation. All parameters |
| 459 |
are in the ``reservation`` object. |
| 460 |
|
| 461 |
.. rest_parameters:: parameters.yaml |
| 462 |
|
| 463 |
- reservation.amount: reservation_amount_optional |
| 464 |
- reservation.vcpus: reservation_vcpus_optional |
| 465 |
- reservation.memory_mb: reservation_memory_mb_optional |
| 466 |
- reservation.disk_gb: reservation_disk_gb_optional |
| 467 |
- reservation.affinity : reservation_affinity_optional |
| 468 |
- reservation.resource_properties: reservation_resource_properties_optional |
| 469 |
|
| 470 |
Parameters for Flavor-based Instance Reservation |
| 471 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 472 |
|
| 473 |
Lease updates are not currently supported for flavor-based instance |
| 474 |
reservations. |
| 475 |
|
| 476 |
**Example of Update Lease Request** |
| 477 |
|
| 478 |
.. literalinclude:: ../../../doc/api_samples/leases/lease-update-req.json |
| 479 |
:language: javascript |
| 480 |
|
| 481 |
Response |
| 482 |
-------- |
| 483 |
|
| 484 |
General Parameters |
| 485 |
^^^^^^^^^^^^^^^^^^ |
| 486 |
|
| 487 |
.. rest_parameters:: parameters.yaml |
| 488 |
|
| 489 |
- lease: lease |
| 490 |
- id: lease_id |
| 491 |
- name: lease_name |
| 492 |
- start_date: lease_start_date_resp |
| 493 |
- end_date: lease_end_date |
| 494 |
- status: lease_status |
| 495 |
- degraded: lease_degraded |
| 496 |
- user_id: lease_user_id |
| 497 |
- project_id: lease_project_id |
| 498 |
- trust_id: lease_trust_id |
| 499 |
- created_at: created_at |
| 500 |
- updated_at: updated_at |
| 501 |
- reservations: reservations |
| 502 |
- reservation.id: reservation_id |
| 503 |
- reservation.lease_id: reservation_lease_id |
| 504 |
- reservation.status: reservation_status |
| 505 |
- reservation.missing_resources: reservation_missing_resources |
| 506 |
- reservation.resources_changed: reservation_resources_changed |
| 507 |
- reservation.resource_id: reservation_resource_id |
| 508 |
- reservation.resource_type: reservation_resource_type |
| 509 |
- reservation.created_at: created_at |
| 510 |
- reservation.updated_at: updated_at |
| 511 |
- events: events |
| 512 |
- event.id: event_id |
| 513 |
- event.lease_id: event_lease_id |
| 514 |
- event.status: event_status |
| 515 |
- event.event_type: event_type |
| 516 |
- event.time: event_time |
| 517 |
- event.created_at: created_at |
| 518 |
- event_updated_at: updated_at |
| 519 |
|
| 520 |
Parameters for Host Reservation |
| 521 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 522 |
|
| 523 |
The following parameters are returned for host reservation. All parameters |
| 524 |
are in the ``reservation`` object. |
| 525 |
|
| 526 |
.. rest_parameters:: parameters.yaml |
| 527 |
|
| 528 |
- reservation.min: reservation_min |
| 529 |
- reservation.max: reservation_max |
| 530 |
- reservation.hypervisor_properties: reservation_hypervisor_properties |
| 531 |
- reservation.resource_properties: reservation_resource_properties |
| 532 |
- reservation.before_end: reservation_before_end |
| 533 |
|
| 534 |
Parameters for Instance Reservation |
| 535 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 536 |
|
| 537 |
The following parameters are returned for instance reservation. All parameters |
| 538 |
are in the ``reservation`` object. |
| 539 |
|
| 540 |
.. rest_parameters:: parameters.yaml |
| 541 |
|
| 542 |
- reservation.amount: reservation_amount |
| 543 |
- reservation.vcpus: reservation_vcpus |
| 544 |
- reservation.memory_mb: reservation_memory_mb |
| 545 |
- reservation.disk_gb: reservation_disk_gb |
| 546 |
- reservation.affinity : reservation_affinity |
| 547 |
- reservation.resource_properties: reservation_resource_properties |
| 548 |
- reservation.flavor_id: reservation_flavor_id |
| 549 |
- reservation.server_group_id: reservation_server_group_id |
| 550 |
- reservation.aggregate_id: reservation_aggregate_id |
| 551 |
|
| 552 |
Parameters for Flavor-based Instance Reservation |
| 553 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 554 |
|
| 555 |
Lease updates are not currently supported for flavor-based instance |
| 556 |
reservations. |
| 557 |
|
| 558 |
**Example of Update Lease Response** |
| 559 |
|
| 560 |
.. literalinclude:: ../../../doc/api_samples/leases/lease-update-resp.json |
| 561 |
:language: javascript |
| 562 |
|
| 563 |
Delete Lease |
| 564 |
============ |
| 565 |
|
| 566 |
.. rest_method:: DELETE v1/leases/{lease_id} |
| 567 |
|
| 568 |
Delete a lease. |
| 569 |
|
| 570 |
**Preconditions** |
| 571 |
|
| 572 |
The lease must exist. |
| 573 |
|
| 574 |
**Response codes** |
| 575 |
|
| 576 |
Normal response codes: 204 |
| 577 |
|
| 578 |
Error response codes: Bad Request(400), Unauthorized(401), Forbidden(403), Not Found(404), |
| 579 |
Conflict(409), Internal Server Error(500) |
| 580 |
|
| 581 |
Request |
| 582 |
------- |
| 583 |
|
| 584 |
.. rest_parameters:: parameters.yaml |
| 585 |
|
| 586 |
- lease_id: lease_id_path |
| 587 |
|
| 588 |
Response |
| 589 |
-------- |
| 590 |
|
| 591 |
No body content is returned on a successful DELETE. |