Add documentation about logs in returned object

This commit is contained in:
Hiroaki Nakamura 2016-06-25 18:08:13 +09:00
parent cf6e3b9ea8
commit 82302e80d4

View file

@ -187,6 +187,10 @@ lxd_container:
description: the old state of the container description: the old state of the container
returned: when state is started or restarted returned: when state is started or restarted
sample: "stopped" sample: "stopped"
logs:
descriptions: the logs of requests and responses
returned: when requests are sent
sample: [{"request": {"json": null, "method": "GET", "timeout": 30, "url": "http+unix://%2Fvar%2Flib%2Flxd%2Funix.socket/1.0/containers/myubuntu"}, "response": {"json": {"metadata": {"architecture": "x86_64", "config": {"limits.cpu": "2", "volatile.base_image": "ed0fb49ea8c3698c96c14157dff05b8c55eab2db438d3b043af1037836f1fa2b", "volatile.eth0.hwaddr": "00:16:3e:f6:fa:b0", "volatile.last_state.idmap": "[{\"Isuid\":true,\"Isgid\":false,\"Hostid\":100000,\"Nsid\":0,\"Maprange\":65536},{\"Isuid\":false,\"Isgid\":true,\"Hostid\":100000,\"Nsid\":0,\"Maprange\":65536}]"}, "created_at": "2016-06-25T18:03:37+09:00", "devices": {"root": {"path": "/", "type": "disk"}}, "ephemeral": false, "expanded_config": {"limits.cpu": "2", "volatile.base_image": "ed0fb49ea8c3698c96c14157dff05b8c55eab2db438d3b043af1037836f1fa2b", "volatile.eth0.hwaddr": "00:16:3e:f6:fa:b0", "volatile.last_state.idmap": "[{\"Isuid\":true,\"Isgid\":false,\"Hostid\":100000,\"Nsid\":0,\"Maprange\":65536},{\"Isuid\":false,\"Isgid\":true,\"Hostid\":100000,\"Nsid\":0,\"Maprange\":65536}]"}, "expanded_devices": {"eth0": {"name": "eth0", "nictype": "bridged", "parent": "lxdbr0", "type": "nic"}, "root": {"path": "/", "type": "disk"}}, "name": "myubuntu", "profiles": ["default"], "stateful": false, "status": "Running", "status_code": 103}, "status": "Success", "status_code": 200, "type": "sync"}}, "type": "sent request"}, {"request": {"json": {"architecture": "x86_64", "config": {"limits.cpu": "2", "volatile.base_image": "ed0fb49ea8c3698c96c14157dff05b8c55eab2db438d3b043af1037836f1fa2b", "volatile.eth0.hwaddr": "00:16:3e:f6:fa:b0", "volatile.last_state.idmap": "[{\"Isuid\":true,\"Isgid\":false,\"Hostid\":100000,\"Nsid\":0,\"Maprange\":65536},{\"Isuid\":false,\"Isgid\":true,\"Hostid\":100000,\"Nsid\":0,\"Maprange\":65536}]"}, "devices": {"root": {"path": "/", "type": "disk"}}, "profiles": ["default"]}, "method": "PUT", "timeout": 30, "url": "http+unix://%2Fvar%2Flib%2Flxd%2Funix.socket/1.0/containers/myubuntu"}, "response": {"json": {"metadata": {"class": "task", "created_at": "2016-06-25T18:03:54.082548079+09:00", "err": "", "id": "e0f6faf3-0cbb-4bd2-9a51-8a3d034d839d", "may_cancel": false, "metadata": null, "resources": {"containers": ["/1.0/containers/myubuntu"]}, "status": "Running", "status_code": 103, "updated_at": "2016-06-25T18:03:54.082548079+09:00"}, "operation": "/1.0/operations/e0f6faf3-0cbb-4bd2-9a51-8a3d034d839d", "status": "Operation created", "status_code": 100, "type": "async"}}, "type": "sent request"}, {"request": {"json": null, "method": "GET", "timeout": 30, "url": "http+unix://%2Fvar%2Flib%2Flxd%2Funix.socket/1.0/operations/e0f6faf3-0cbb-4bd2-9a51-8a3d034d839d/wait?timeout=30"}, "response": {"json": {"metadata": {"class": "task", "created_at": "2016-06-25T18:03:54.082548079+09:00", "err": "", "id": "e0f6faf3-0cbb-4bd2-9a51-8a3d034d839d", "may_cancel": false, "metadata": null, "resources": {"containers": ["/1.0/containers/myubuntu"]}, "status": "Success", "status_code": 200, "updated_at": "2016-06-25T18:03:54.082548079+09:00"}, "status": "Success", "status_code": 200, "type": "sync"}}, "type": "sent request"}]
actions: actions:
description: list of actions performed for the container description: list of actions performed for the container
returned: success returned: success