Add api-ref for container resize
This patch adds api-ref for container resize. Change-Id: I04feb20ebee1dbd444a228b850551ce7efd45f66 Partially-Implements: bp zun-api-doc
This commit is contained in:
parent
0242d05c40
commit
f0632c5435
@ -4,7 +4,7 @@
|
|||||||
Manage Containers
|
Manage Containers
|
||||||
===================
|
===================
|
||||||
|
|
||||||
Lists, creates, shows details for, stats, updates, deletes, starts,
|
Lists, creates, shows details for, stats, updates, deletes, starts, resize,
|
||||||
stops, pauses, unpauses, restarts, renames, commits containers, and adds
|
stops, pauses, unpauses, restarts, renames, commits containers, and adds
|
||||||
security group for specified container.
|
security group for specified container.
|
||||||
|
|
||||||
@ -724,6 +724,53 @@ Response
|
|||||||
|
|
||||||
This request does not return anything in the response body.
|
This request does not return anything in the response body.
|
||||||
|
|
||||||
.. rest_parameters:; parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- X-Openstack-Request-Id: request_id
|
- X-Openstack-Request-Id: request_id
|
||||||
|
|
||||||
|
|
||||||
|
Resize a container
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1/containers/{container_ident}/resize?w={width}&h={height}
|
||||||
|
|
||||||
|
Resize tty to a container
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
This API is primarily designed to be used by zunclient or Zun-UI.
|
||||||
|
The point of this API is to coordinate between client-side tools and
|
||||||
|
Zun to adjust the size of the TTY for the container.
|
||||||
|
Unless you are writing client-side tools you **should not** be using
|
||||||
|
this API.
|
||||||
|
|
||||||
|
Response Codes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
.. rest_status_code:: success status.yaml
|
||||||
|
|
||||||
|
- 200
|
||||||
|
|
||||||
|
.. rest_status_code:: error status.yaml
|
||||||
|
|
||||||
|
- 401
|
||||||
|
- 403
|
||||||
|
- 404
|
||||||
|
- 409
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- container_ident: container_ident
|
||||||
|
- width: width
|
||||||
|
- height: height
|
||||||
|
|
||||||
|
Response
|
||||||
|
--------
|
||||||
|
|
||||||
|
This request does not return anything in the response body.
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- X-Openstack-Request-Id: request_id
|
||||||
|
@ -17,9 +17,15 @@ force:
|
|||||||
in: query
|
in: query
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
height:
|
||||||
|
description: |
|
||||||
|
The tty height of a container.
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
network:
|
network:
|
||||||
description: |
|
description: |
|
||||||
network to be detached of the container.
|
Network to be detached of the container.
|
||||||
in: query
|
in: query
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
@ -29,6 +35,12 @@ timeout:
|
|||||||
in: query
|
in: query
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
width:
|
||||||
|
description: |
|
||||||
|
The tty width of a container.
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
addresses:
|
addresses:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
|
Loading…
x
Reference in New Issue
Block a user