Added doc for new fields in GET_CONTAINERS operator API. Review: https://reviews.apache.org/r/64653
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/d9951bd5 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/d9951bd5 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/d9951bd5 Branch: refs/heads/master Commit: d9951bd5214d34f7a014a38bae5e1b733b45cb38 Parents: 7de21b1 Author: Jie Yu <[email protected]> Authored: Fri Dec 15 10:16:55 2017 -0800 Committer: Jie Yu <[email protected]> Committed: Fri Dec 15 13:56:50 2017 -0800 ---------------------------------------------------------------------- docs/operator-http-api.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/d9951bd5/docs/operator-http-api.md ---------------------------------------------------------------------- diff --git a/docs/operator-http-api.md b/docs/operator-http-api.md index fbe2914..f81e5bc 100644 --- a/docs/operator-http-api.md +++ b/docs/operator-http-api.md @@ -3169,6 +3169,11 @@ Content-Type: application/json This call retrieves information about containers running on this agent. It contains ContainerStatus and ResourceStatistics along with some metadata of the containers. +There are two knobs in the request to control the types of the containers this +API will return: +* `show_nested`: Whether to show nested containers [default: false]. +* `show_standalone`: Whether to show standalone containers [default: false]. + ``` GET_CONTAINERS HTTP Request (JSON): @@ -3179,7 +3184,11 @@ Content-Type: application/json Accept: application/json { - "type": "GET_CONTAINERS" + "type": "GET_CONTAINERS", + "get_containers": { + "show_nested": true, + "show_standalone": false + } }
