diff options
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/images.inc | 14 | ||||
| -rw-r--r-- | api-ref/source/index.rst | 4 | ||||
| -rw-r--r-- | api-ref/source/os-consoles.inc | 69 | ||||
| -rw-r--r-- | api-ref/source/os-floating-ip-pools.inc | 2 | ||||
| -rw-r--r-- | api-ref/source/os-floating-ips.inc | 12 | ||||
| -rw-r--r-- | api-ref/source/os-networks.inc | 79 | ||||
| -rw-r--r-- | api-ref/source/os-security-group-default-rules.inc | 22 | ||||
| -rw-r--r-- | api-ref/source/os-server-external-events.inc | 10 | ||||
| -rw-r--r-- | api-ref/source/os-services.inc | 6 | ||||
| -rw-r--r-- | api-ref/source/os-tenant-network.inc | 12 | ||||
| -rw-r--r-- | api-ref/source/os-volume-attachments.inc | 8 | ||||
| -rw-r--r-- | api-ref/source/os-volumes.inc | 8 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 35 | ||||
| -rw-r--r-- | api-ref/source/server-migrations.inc | 4 | ||||
| -rw-r--r-- | api-ref/source/servers-action-remote-consoles.inc | 11 | ||||
| -rw-r--r-- | api-ref/source/servers-actions.inc | 18 | ||||
| -rw-r--r-- | api-ref/source/servers-admin-action.inc | 12 | ||||
| -rw-r--r-- | api-ref/source/servers-remote-consoles.inc | 58 | ||||
| -rw-r--r-- | api-ref/source/servers.inc | 13 |
19 files changed, 206 insertions, 191 deletions
diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index 69ae4cf087..621641281f 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -103,7 +103,7 @@ Response - name: image_name - minRam: minRam_body - minDisk: minDisk_body - - metadata: metadata_object + - metadata: metadata_object - created: created - updated: updated - status: image_status @@ -147,7 +147,7 @@ Response - name: image_name - minRam: minRam_body - minDisk: minDisk_body - - metadata: metadata_object + - metadata: metadata_object - created: created - updated: updated - status: image_status @@ -208,7 +208,7 @@ Response .. rest_parameters:: parameters.yaml - - metadata: metadata_object + - metadata: metadata_object **Example List Image Metadata Details: JSON response** @@ -233,7 +233,7 @@ Request .. rest_parameters:: parameters.yaml - image_id: image_id - - metadata: metadata_object + - metadata: metadata_object **Example Create Image Metadata: JSON request** @@ -245,7 +245,7 @@ Response .. rest_parameters:: parameters.yaml - - metadata: metadata_object + - metadata: metadata_object **Example Create Image Metadata: JSON response** @@ -270,7 +270,7 @@ Request .. rest_parameters:: parameters.yaml - image_id: image_id - - metadata: metadata_object + - metadata: metadata_object **Example Update Image Metadata: JSON request** @@ -282,7 +282,7 @@ Response .. rest_parameters:: parameters.yaml - - metadata: metadata_object + - metadata: metadata_object **Example Update Image Metadata: JSON response** diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index b83346f4a7..99e3d66636 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -41,7 +41,6 @@ the `API guide <https://docs.openstack.org/api-guide/compute/index.html>`_. .. include:: os-aggregates.inc .. include:: os-assisted-volume-snapshots.inc .. include:: os-availability-zone.inc -.. include:: os-consoles.inc .. include:: os-hypervisors.inc .. include:: os-instance-usage-audit-log.inc .. include:: os-migrations.inc @@ -71,7 +70,6 @@ limited to some maximum microversion. .. include:: os-floating-ip-pools.inc .. include:: os-floating-ips.inc .. include:: os-security-groups.inc -.. include:: os-security-group-default-rules.inc .. include:: os-security-group-rules.inc .. include:: os-hosts.inc @@ -90,3 +88,5 @@ Compute API in the past, but no longer exist. .. include:: os-floating-ips-bulk.inc .. include:: os-floating-ip-dns.inc .. include:: os-cells.inc +.. include:: os-consoles.inc +.. include:: os-security-group-default-rules.inc diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc index b19bf70665..fe3c654589 100644 --- a/api-ref/source/os-consoles.inc +++ b/api-ref/source/os-consoles.inc @@ -1,12 +1,15 @@ .. -*- rst -*- -=============================================================== - Server consoles (servers, os-consoles, os-console-auth-tokens) -=============================================================== +================================================== + XenServer VNC Proxy (XVP) consoles (os-consoles) +================================================== -Manages server consoles. +Manages server XVP consoles. -.. note:: This is only used in Xenserver VNC Proxy. +.. warning:: + + These APIs are only applicable when using the XenServer virt driver. + They were removed in the 21.0.0 (Ussuri) release. Lists Consoles ============== @@ -17,7 +20,7 @@ Lists all consoles for a server. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403) +Error response codes: unauthorized(401), forbidden(403), gone(410) Request ------- @@ -53,7 +56,8 @@ Creates a console for a server. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410) Request ------- @@ -77,7 +81,8 @@ Shows console details for a server. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410) Request ------- @@ -117,7 +122,8 @@ Deletes a console for a server. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410) Request ------- @@ -132,48 +138,3 @@ Response -------- If successful, this method does not return a response body. - - -Show Console Connection Information -=================================== - -.. rest_method:: GET /os-console-auth-tokens/{console_token} - -Given the console authentication token for a server, -shows the related connection information. - -This method used to be available only for the ``rdp-html5`` console type before -microversion 2.31. Starting from microversion 2.31 it's available for all -console types. - -Normal response codes: 200 - -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - console_token: console_token - -| - -Response --------- - -.. rest_parameters:: parameters.yaml - - - console: console - - instance_uuid: instance_id_body - - host: console_host - - port: port_number - - internal_access_path: internal_access_path - -| - -**Example Show Console Authentication Token** - -.. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json - :language: javascript diff --git a/api-ref/source/os-floating-ip-pools.inc b/api-ref/source/os-floating-ip-pools.inc index 4054daf41a..7860560269 100644 --- a/api-ref/source/os-floating-ip-pools.inc +++ b/api-ref/source/os-floating-ip-pools.inc @@ -38,7 +38,7 @@ Response .. rest_parameters:: parameters.yaml - floating_ip_pools: floating_ip_pools - - name: floating_ip_pool_name + - name: floating_ip_pool_name_or_id **Example List Floating Ip Pools: JSON response** diff --git a/api-ref/source/os-floating-ips.inc b/api-ref/source/os-floating-ips.inc index 89c349fa5b..a4911dec21 100644 --- a/api-ref/source/os-floating-ips.inc +++ b/api-ref/source/os-floating-ips.inc @@ -62,7 +62,7 @@ Response - id: floating_ip_id_value - instance_id: server_id - ip: floating_ip - - pool: floating_ip_pool_name + - pool: floating_ip_pool_name_or_id **Example List Floating Ip Addresses** @@ -86,7 +86,7 @@ can change these permissions through the ``policy.json`` file. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), +Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) Request @@ -94,7 +94,7 @@ Request .. rest_parameters:: parameters.yaml - - pool: floating_ip_pool_name + - pool: floating_ip_pool_name_or_id **Example Create (Allocate) Floating Ip Address** @@ -111,7 +111,7 @@ Response - id: floating_ip_id_value - instance_id: server_id - ip: floating_ip - - pool: floating_ip_pool_name + - pool: floating_ip_pool_name_or_id **Example Create (Allocate) Floating Ip Address: JSON response** @@ -131,7 +131,7 @@ can change these permissions through the ``policy.json`` file. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), +Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) Request @@ -151,7 +151,7 @@ Response - id: floating_ip_id_value - instance_id: server_id - ip: floating_ip - - pool: floating_ip_pool_name + - pool: floating_ip_pool_name_or_id **Example Show Floating Ip Address Details: JSON response** diff --git a/api-ref/source/os-networks.inc b/api-ref/source/os-networks.inc index 99477e266d..a9ee87f69a 100644 --- a/api-ref/source/os-networks.inc +++ b/api-ref/source/os-networks.inc @@ -1,28 +1,26 @@ .. -*- rst -*- -.. NOTE(sdague): These APIs are deprecated so do not update this - file even body, example or parameters are not complete. -===================================== +====================================== Networks (os-networks) (DEPRECATED) -===================================== +====================================== -.. warning:: The networks API was designed to work with - ``nova-network``. Some features are proxied to - ``neutron`` when appropriate, but as with all translation - proxies, this is far from perfect compatibility. These - APIs should be avoided in new applications in favor of - using ``neutron`` directly. These will fail with a 404 - starting from microversion 2.36. - See: `Relevant Network APIs - <https://docs.openstack.org/api-ref/network/v2/#networks>`__. +.. warning:: + + This API was designed to work with ``nova-network`` which was deprecated in + the 14.0.0 (Newton) release and removed in the 21.0.0 (Ussuri) release. Some + features are proxied to the Network service (neutron) when appropriate, but + as with all translation proxies, this is far from perfect compatibility. + These APIs should be avoided in new applications in favor of `using + neutron directly`__. These will fail with a 404 starting from microversion + 2.36. They were removed in the 21.0.0 (Ussuri) release. +__ https://docs.openstack.org/api-ref/network/v2/#networks Creates, lists, shows information for, and deletes networks. Adds network to a project, disassociates a network from a project, and disassociates a project from a network. - Associates host with and disassociates host from a network. List Networks @@ -60,7 +58,8 @@ these permissions through the ``policy.json`` file. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409), NotImplemented(501) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +conflict(409), gone(410), notImplemented(501) Request ------- @@ -91,7 +90,8 @@ this operation. Cloud providers can change these permissions through the Normal response codes: 202 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), NotImplemented(501) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +gone(410), notImplemented(501) Request ------- @@ -146,7 +146,8 @@ these permissions through the ``policy.json`` file. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +conflict(409), gone(410) Request ------- @@ -160,15 +161,11 @@ Response There is no body content for the response of a successful DELETE query. -Associate Host (DEPRECATED) -=========================== +Associate Host +============== .. rest_method:: POST /os-networks/{network_id}/action -.. warning:: - This API is only available with ``nova-network`` which is - deprecated. It should be avoided in any new applications. - Associates a network with a host. Specify the ``associate_host`` action in the request body. @@ -179,7 +176,8 @@ permissions through the ``policy.json`` file. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410), notImplemented(501) Request ------- @@ -199,15 +197,11 @@ Response There is no body content for the response of a successful POST query. -Disassociate Network (DEPRECATED) -================================= +Disassociate Network +==================== .. rest_method:: POST /os-networks/{network_id}/action -.. warning:: - This API is only available with ``nova-network`` which is - deprecated. It should be avoided in any new applications. - Disassociates a network from a project. You can then reuse the network. Specify the ``disassociate`` action in the request body. @@ -218,7 +212,8 @@ these permissions through the ``policy.json`` file. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410), notImplemented(501) Request ------- @@ -237,15 +232,11 @@ Response There is no body content for the response of a successful POST query. -Disassociate Host (DEPRECATED) -============================== +Disassociate Host +================= .. rest_method:: POST /os-networks/{network_id}/action -.. warning:: - This API is only available with ``nova-network`` which is - deprecated. It should be avoided in any new applications. - Disassociates a host from a network. Specify the ``disassociate_host`` action in the request body. @@ -256,7 +247,8 @@ these permissions through the ``policy.json`` file. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410), notImplemented(501) Request ------- @@ -276,15 +268,11 @@ Response There is no body content for the response of a successful POST query. -Disassociate Project (DEPRECATED) -================================= +Disassociate Project +==================== .. rest_method:: POST /os-networks/{network_id}/action -.. warning:: - This API is only available with ``nova-network`` which is - deprecated. It should be avoided in any new applications. - Disassociates a project from a network. Specify the ``disassociate_project`` action in the request body. @@ -295,7 +283,8 @@ these permissions through the ``policy.json`` file. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410), notImplemented(501) Request ------- diff --git a/api-ref/source/os-security-group-default-rules.inc b/api-ref/source/os-security-group-default-rules.inc index e2a9aba552..9d47f0ad25 100644 --- a/api-ref/source/os-security-group-default-rules.inc +++ b/api-ref/source/os-security-group-default-rules.inc @@ -1,17 +1,15 @@ .. -*- rst -*- -.. NOTE(gmann): These APIs are deprecated so do not update this - file even body, example or parameters are not complete. - -================================================================================ - Rules for default security group (os-security-group-default-rules) (DEPRECATED) -================================================================================ +==================================================================== + Rules for default security group (os-security-group-default-rules) +==================================================================== .. warning:: This API only available with ``nova-network`` which is deprecated. It should be avoided in any new applications. These will fail with a 404 starting from microversion 2.36. + They were completely removed in the 21.0.0 (Ussuri) release. Lists, shows information for, and creates default security group rules. @@ -24,7 +22,8 @@ Lists default security group rules. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410), notImplemented(501) Response -------- @@ -53,7 +52,8 @@ Shows details for a security group rule. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +itemNotFound(404), gone(410), notImplemented(501) Request ------- @@ -92,7 +92,8 @@ IP protocol ( ``ip_protocol`` ) value. Otherwise, the operation returns the ``Ba Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409), notImplemented(501) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +conflict(409), gone(410), notImplemented(501) Request ------- @@ -137,7 +138,8 @@ Deletes a security group rule. Normal response codes: 204 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +itemNotFound(404), gone(410), notImplemented(501) Request ------- diff --git a/api-ref/source/os-server-external-events.inc b/api-ref/source/os-server-external-events.inc index f04c98839f..d96bc26396 100644 --- a/api-ref/source/os-server-external-events.inc +++ b/api-ref/source/os-server-external-events.inc @@ -32,11 +32,15 @@ updated ``code`` and ``status`` indicating their level of success. Normal response codes: 200, 207 A 200 will be returned if all events succeeded, 207 will be returned -if some events could not be processed. The ``code`` attribute for the +if any events could not be processed. The ``code`` attribute for the event will explain further what went wrong. -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404) +Error response codes: badRequest(400), unauthorized(401), forbidden(403) + +.. note:: Prior to the fix for `bug 1855752`_, error response code 404 may be + erroneously returned when all events failed. + +.. _bug 1855752: https://bugs.launchpad.net/nova/+bug/1855752 Request ------- diff --git a/api-ref/source/os-services.inc b/api-ref/source/os-services.inc index 788179b0a7..af495b4bac 100644 --- a/api-ref/source/os-services.inc +++ b/api-ref/source/os-services.inc @@ -349,6 +349,12 @@ Attempts to delete a ``nova-compute`` service which is still hosting instances will result in a 409 HTTPConflict response. The instances will need to be migrated or deleted before a compute service can be deleted. +Similarly, attempts to delete a ``nova-compute`` service which is involved in +in-progress migrations will result in a 409 HTTPConflict response. The +migrations will need to be completed, for example confirming or reverting a +resize, or the instances will need to be deleted before the compute service can +be deleted. + .. important:: Be sure to stop the actual ``nova-compute`` process on the physical host *before* deleting the service with this API. Failing to do so can lead to the running service re-creating diff --git a/api-ref/source/os-tenant-network.inc b/api-ref/source/os-tenant-network.inc index ceb405800f..41314fb24c 100644 --- a/api-ref/source/os-tenant-network.inc +++ b/api-ref/source/os-tenant-network.inc @@ -1,10 +1,8 @@ .. -*- rst -*- -.. NOTE(gmann): These APIs are deprecated so do not update this - file even body, example or parameters are not complete. -=================================================== +==================================================== Project networks (os-tenant-networks) (DEPRECATED) -=================================================== +==================================================== .. warning:: @@ -57,7 +55,8 @@ through the ``policy.json`` file. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409), serviceUnavailable(503) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +conflict(409), gone(410), serviceUnavailable(503) **Example Create Project Network: JSON request** @@ -121,7 +120,8 @@ can change these permissions through the ``policy.json`` file. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +conflict(409), gone(410) Request ------- diff --git a/api-ref/source/os-volume-attachments.inc b/api-ref/source/os-volume-attachments.inc index d93167893b..3deb96d05a 100644 --- a/api-ref/source/os-volume-attachments.inc +++ b/api-ref/source/os-volume-attachments.inc @@ -46,9 +46,9 @@ Response .. literalinclude:: ../../doc/api_samples/os-volumes/list-volume-attachments-resp.json :language: javascript -**Example List tagged volume attachments for an instance (v2.70): JSON response** +**Example List tagged volume attachments for an instance (v2.79): JSON response** -.. literalinclude:: ../../doc/api_samples/os-volumes/v2.70/list-volume-attachments-resp.json +.. literalinclude:: ../../doc/api_samples/os-volumes/v2.79/list-volume-attachments-resp.json :language: javascript Attach a volume to an instance @@ -162,9 +162,9 @@ Response .. literalinclude:: ../../doc/api_samples/os-volumes/volume-attachment-detail-resp.json :language: javascript -**Example Show a detail of a tagged volume attachment (v2.70): JSON response** +**Example Show a detail of a tagged volume attachment (v2.79): JSON response** -.. literalinclude:: ../../doc/api_samples/os-volumes/v2.70/volume-attachment-detail-resp.json +.. literalinclude:: ../../doc/api_samples/os-volumes/v2.79/volume-attachment-detail-resp.json :language: javascript Update a volume attachment diff --git a/api-ref/source/os-volumes.inc b/api-ref/source/os-volumes.inc index b95edc2ee6..1f71197890 100644 --- a/api-ref/source/os-volumes.inc +++ b/api-ref/source/os-volumes.inc @@ -50,7 +50,7 @@ Response - displayDescription: display_description - displayName: display_name - id: volume_id_resp - - metadata: metadata_object + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status @@ -110,7 +110,7 @@ Response - displayName: display_name - displayDescription: display_description - id: volume_id_resp - - metadata: metadata_object + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status @@ -158,7 +158,7 @@ Response - displayName: display_name - displayDescription: display_description - id: volume_id_resp - - metadata: metadata_object + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status @@ -205,7 +205,7 @@ Response - displayName: display_name - displayDescription: display_description - id: volume_id_resp - - metadata: metadata_object + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 8401601740..bc828c85f0 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2648,6 +2648,7 @@ event_name: - ``network-vif-deleted`` - ``volume-extended`` (since microversion ``2.51``) - ``power-update`` (since microversion ``2.76``) + - ``accelerator-request-bound`` (since microversion ``2.82``) in: body required: true @@ -2685,6 +2686,8 @@ event_tag: A string value that identifies the event. Certain types of events require specific tags: + - For the ``accelerator-request-bound`` event, the tag must be + the accelerator request UUID. - For the ``power-update`` event the tag must be either be ``POWER_ON`` or ``POWER_OFF``. - For the ``volume-extended`` event the tag must be the volume id. @@ -3213,16 +3216,22 @@ floating_ip_obj: type: object floating_ip_pool_name: description: | - The name of the floating ip pool. + The name of the floating IP pool. in: body required: true type: string floating_ip_pool_name_optional: description: | - The name of the floating ip pool + The name of the floating IP pool in: body required: false type: string +floating_ip_pool_name_or_id: + description: | + The name or ID of the floating IP pool. + in: body + required: true + type: string floating_ip_pools: description: | The ``floating_ip_pools`` object. @@ -3832,7 +3841,7 @@ hypervisors: image: description: | The UUID and links for the image for your server instance. The ``image`` object - might be an empty string when you boot the server from a volume. + will be an empty string when you boot the server from a volume. in: body required: true type: object @@ -4033,8 +4042,8 @@ instance_actions_next_links: description: | Links pertaining to the instance action. This parameter is returned when paging and more data is available. - See `API Guide / Links and References - <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_ + See `Paginated collections + <https://docs.openstack.org/api-guide/compute/paginated_collections.html>`__ for more info. in: body required: false @@ -4731,8 +4740,8 @@ migration_links_2_23: Links to the migration. This parameter is returned if the migration type is ``live-migration`` and the migration status is one of ``queued``, ``preparing``, ``running`` - and ``post-migrating``. See `API Guide / Links and References - <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_ + and ``post-migrating``. See `Paginated collections + <https://docs.openstack.org/api-guide/compute/paginated_collections.html>`__ for more info. in: body required: false @@ -4754,8 +4763,8 @@ migration_next_links_2_59: description: | Links pertaining to the migration. This parameter is returned when paging and more data is available. - See `API Guide / Links and References - <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_ + See `Paginated collections + <https://docs.openstack.org/api-guide/compute/paginated_collections.html>`__ for more info. in: body required: false @@ -5284,7 +5293,7 @@ os-getVNCConsole: type: object os-getVNCConsole-type: description: | - The type of VNC console. The valid values are ``novnc`` and ``xvpvnc``. + The type of VNC console. The only valid value is ``novnc``. in: body required: true type: string @@ -5833,7 +5842,7 @@ remote_console_protocol: type: string remote_console_type: description: | - The type of remote console. The valid values are ``novnc``, ``xvpvnc``, + The type of remote console. The valid values are ``novnc``, ``rdp-html5``, ``spice-html5``, ``serial``, and ``webmks``. The type ``webmks`` is added since Microversion ``2.8``. in: body @@ -6551,8 +6560,8 @@ servers_links: description: | Links to the next server. It is available when the number of servers exceeds ``limit`` parameter or ``[api]/max_limit`` in the configuration file. - See `API Guide / Links and References - <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_ + See `Paginated collections + <https://docs.openstack.org/api-guide/compute/paginated_collections.html>`__ for more info. in: body type: array diff --git a/api-ref/source/server-migrations.inc b/api-ref/source/server-migrations.inc index 7608937eb0..52e413470f 100644 --- a/api-ref/source/server-migrations.inc +++ b/api-ref/source/server-migrations.inc @@ -195,9 +195,11 @@ Abort an in-progress live migration. .. note:: With microversion 2.65 or greater, you can abort live migrations also in ``queued`` and ``preparing`` status. -.. note:: Not all compute back ends support aborting an in-progress live +.. note:: Not all `compute back ends`__ support aborting an in-progress live migration. +.. __: https://docs.openstack.org/nova/latest/user/support-matrix.html#operation_abort_in_progress_live_migration + Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. diff --git a/api-ref/source/servers-action-remote-consoles.inc b/api-ref/source/servers-action-remote-consoles.inc index 105a00dd10..582365c2fc 100644 --- a/api-ref/source/servers-action-remote-consoles.inc +++ b/api-ref/source/servers-action-remote-consoles.inc @@ -11,7 +11,7 @@ Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ con .. warning:: This action is deprecated in microversion 2.5 and superseded - by the API `Server Remote Consoles`_ in microversion 2.6. + by the API `Server Consoles`_ in microversion 2.6. The new API offers a unified API for different console types. The only supported connect type is ``rdp-html5``. The ``type`` parameter should @@ -64,7 +64,7 @@ Gets a serial console for a server. .. warning:: This action is deprecated in microversion 2.5 and superseded - by the API `Server Remote Consoles`_ in microversion 2.6. + by the API `Server Consoles`_ in microversion 2.6. The new API offers a unified API for different console types. Specify the ``os-getSerialConsole`` action in the request body. @@ -117,7 +117,7 @@ Gets a SPICE console for a server. .. warning:: This action is deprecated in microversion 2.5 and superseded - by the API `Server Remote Consoles`_ in microversion 2.6. + by the API `Server Consoles`_ in microversion 2.6. The new API offers a unified API for different console types. Specify the ``os-getSPICEConsole`` action in the request body. @@ -170,14 +170,11 @@ Gets a VNC console for a server. .. warning:: This action is deprecated in microversion 2.5 and superseded - by the API `Server Remote Consoles`_ in microversion 2.6. + by the API `Server Consoles`_ in microversion 2.6. The new API offers a unified API for different console types. Specify the ``os-getVNCConsole`` action in the request body. -The supported connection types are ``novnc``, ``xvpvnc``. Such as connect -with ``novnc``, set ``type`` parameter to ``novnc``. - Normal response codes: 200 Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index 6092f9459f..47b12705d6 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -800,12 +800,6 @@ Resizes a server. Specify the ``resize`` action in the request body. -A successfully resized server shows a ``VERIFY_RESIZE`` status, -``RESIZED`` VM status, and ``finished`` migration status. If you set the -``resize_confirm_window`` option of the Compute service to an integer value, -the Compute service automatically confirms the resize operation after -the set interval in seconds. - **Preconditions** You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``. @@ -813,6 +807,18 @@ You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``. If the server is locked, you must have administrator privileges to resize the server. +**Asynchronous Postconditions** + +A successfully resized server shows a ``VERIFY_RESIZE`` status and ``finished`` +migration status. If the cloud has configured the `resize_confirm_window`_ +option of the Compute service to a positive value, the Compute service +automatically confirms the resize operation after the configured interval. + +.. _resize_confirm_window: https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.resize_confirm_window + +.. note:: There is a `known limitation <https://bugs.launchpad.net/nova/+bug/1558880>`__ + that ephemeral disks are not resized. + Normal response codes: 202 Error response codes: badRequest(400), unauthorized(401), forbidden(403), diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc index de1e3b84d6..2c99eab68e 100644 --- a/api-ref/source/servers-admin-action.inc +++ b/api-ref/source/servers-admin-action.inc @@ -68,12 +68,12 @@ this parameter, the scheduler chooses a host. **Asynchronous Postconditions** -The server goes to a ``VERIFY_RESIZE`` status, ``RESIZED`` VM status, -and ``finished`` migration status after a successful cold migration -and then must be confirmed or reverted. If you set the -``resize_confirm_window`` option of the Compute service to a positive integer -value, the Compute service automatically confirms the migrate operation -after the set interval in seconds. +A successfully migrated server shows a ``VERIFY_RESIZE`` status and ``finished`` +migration status. If the cloud has configured the `resize_confirm_window`_ +option of the Compute service to a positive value, the Compute service +automatically confirms the migrate operation after the configured interval. + +.. _resize_confirm_window: https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.resize_confirm_window Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions diff --git a/api-ref/source/servers-remote-consoles.inc b/api-ref/source/servers-remote-consoles.inc index 7bcf96b17c..c8515d3315 100644 --- a/api-ref/source/servers-remote-consoles.inc +++ b/api-ref/source/servers-remote-consoles.inc @@ -1,13 +1,13 @@ .. -*- rst -*- -====================== -Server Remote Consoles -====================== +================= + Server Consoles +================= -Create server remote console. +Manage server consoles. -Create Remote Console -===================== +Create Console +============== .. rest_method:: POST /servers/{server_id}/remote-consoles @@ -17,9 +17,7 @@ The API provides a unified request for creating a remote console. The user can get a URL to connect the console from this API. The URL includes the token which is used to get permission to access the console. Servers may support different console protocols. To return a remote console using a specific -protocol, such as RDP, set the ``protocol`` parameter to ``rdp``. For the same -protocol, there may be different connection types such as ``vnc protocol and -novnc type`` or ``vnc protocol and xvpvnc type``. +protocol, such as RDP, set the ``protocol`` parameter to ``rdp``. Normal response codes: 200 @@ -56,3 +54,45 @@ Response .. literalinclude:: ../../doc/api_samples/os-remote-consoles/v2.6/create-vnc-console-resp.json :language: javascript + + +Show Console Connection Information +=================================== + +.. rest_method:: GET /os-console-auth-tokens/{console_token} + +Given the console authentication token for a server, shows the related +connection information. + +This method used to be available only for the ``rdp-html5`` console type before +microversion 2.31. Starting from microversion 2.31 it's available for all +console types. + +Normal response codes: 200 + +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +itemNotFound(404) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - console_token: console_token + + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - console: console + - instance_uuid: instance_id_body + - host: console_host + - port: port_number + - internal_access_path: internal_access_path + +**Example Show Console Authentication Token** + +.. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json + :language: javascript diff --git a/api-ref/source/servers.inc b/api-ref/source/servers.inc index 8921e93eb7..6334a96fef 100644 --- a/api-ref/source/servers.inc +++ b/api-ref/source/servers.inc @@ -139,13 +139,12 @@ body. The possible server status values are: - ``SOFT_DELETED``. The server is marked as deleted but the disk images are still available to restore. - ``SUSPENDED``. The server is suspended, either by request or - necessity. This status appears for only the XenServer/XCP, KVM, and - ESXi hypervisors. Administrative users can suspend an instance if it - is infrequently used or to perform system maintenance. When you - suspend an instance, its VM state is stored on disk, all memory is - written to disk, and the virtual machine is stopped. Suspending an - instance is similar to placing a device in hibernation; memory and - vCPUs become available to create other instances. + necessity. When you suspend a server, its state is stored + on disk, all memory is written to disk, and the server is stopped. + Suspending a server is similar to placing a device in hibernation and its + occupied resource will not be freed but rather kept for when the server is + resumed. If a server is infrequently used and the occupied resource needs + to be freed to create other servers, it should be shelved. - ``UNKNOWN``. The state of the server is unknown. Contact your cloud provider. - ``VERIFY_RESIZE``. System is awaiting confirmation that the server |