Add api-ref for container logs

This patch adds api-ref for container logs.

Closes-Bug: #1720924
Change-Id: I652a5a592ecfe0f06e8df594ba4074f285ab891c
This commit is contained in:
miaohb 2017-10-08 23:54:08 -07:00
parent 94ee6dabd8
commit ef340fecb1
3 changed files with 84 additions and 1 deletions

View File

@ -6,7 +6,7 @@
Lists, creates, shows details for, stats, updates, deletes, starts, resize, 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, gets logs of a container.
Create new container Create new container
==================== ====================
@ -819,3 +819,49 @@ 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
Get logs of a container
=======================
.. rest_method:: GET /v1/containers/{container_ident}/logs?timestamps={timestamps}&&since={since}&tail={tail}&stderr={stderr}&stdout={stdout}
Get logs of a container.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- container_ident: container_ident
- timestamps: timestamps
- tail: tail
- stderr: stderr
- stdout: stdout
- since: since
Request Example
----------------
.. literalinclude:: samples/container-logs-req.json
:language: javascript
Response
--------
This request returns logs string as a response, which is
not in json format.

View File

@ -53,18 +53,48 @@ security_group_query:
in: query in: query
required: true required: true
type: string type: string
since:
description: |
Show logs since a given datetime or integer epoch (in seconds).
in: query
required: false
type: string
stderr:
description: |
Get standard error if True.
in: query
required: false
type: boolean
stdout:
description: |
Get standard output if True.
in: query
required: false
type: boolean
tag: tag:
description: | description: |
The tag of the container image. The tag of the container image.
in: query in: query
required: true required: true
type: string type: string
tail:
description: |
Number of lines to show from the end of the logs, default is get all logs.
in: query
required: false
type: string
timeout: timeout:
description: | description: |
Seconds to wait before operating on container. Seconds to wait before operating on container.
in: query in: query
required: true required: true
type: string type: string
timestamps:
description: |
Whether to show timestamps in the logs of container.
in: query
required: false
type: boolean
width: width:
description: | description: |
The tty width of a container. The tty width of a container.

View File

@ -0,0 +1,7 @@
{
"timestamps": "True",
"tail": "all",
"since": "600000",
"stderr": "True",
"stdout": "True"
}