Actions

GET

/api/actions

Получение списка выполненных действий

Запрос

Параметры запроса:

Name	In	Type	Description
where (Optional)	url parameters	JSON object	Фильтр элементов. Используется синтаксис mongo запросов.
sort (Optional)	url parameters	string	Сортировка элементов.
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.
page (Optional)	url parameters	integer	Номер страницы элементов.
max_results (Optional)	url parameters	integer	Максимальное число элементов на одной странице.

Пример запроса:

curl -X GET http://tkcontrol/api/actions?sort=-_created&where={"action":"cmd.run"}

Ответ

Пример ответа:

{
    "_items": [
        {
            "_id": "20200508145333792248medpc-6616cd.localdomain",
            "jid": "20200508145333792248",
            "action": "cmd.run",
            "host": "medpc-6616cd.localdomain",
            "state": "finished",
            "args": [
                {
                    "cmd": "ip a",
                    "__kwarg__": true
                 }
            ],
            "_updated": "Fri, 08 May 2020 11:59:12 GMT",
            "_created": "Fri, 08 May 2020 11:59:11 GMT",
            "return": "1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdis ...",
            "_links": {
                "self": {
                    "title": "Action",
                    "href": "actions/20200508145333792248medpc-6616cd.localdomain"
                },
                "related": {
                    "host": {
                        "title": "Host",
                        "href": "hosts/medpc-6616cd.localdomain"
                    }
                }
             }
         },
        {
            "_id": "20200508145312937405skupov-salt-minion-dev5",
            "jid": "20200508145312937405",
            "action": "cmd.run",
            "host": "skupov-salt-minion-dev5",
            "state": "finished",
            "args": [
                {
                    "cmd": "ip a",
                    "__kwarg__": true
                }
            ],
            "_updated": "Fri, 08 May 2020 11:58:51 GMT",
            "_created": "Fri, 08 May 2020 11:58:51 GMT",
            "return": "1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdis ...",
            "_links": {
               "self": {
                 "title": "Action",
                  "href": "actions/20200508145312937405skupov-salt-minion-dev5"
                },
                "related": {
                   "host": {
                       "title": "Host",
                       "href": "hosts/skupov-salt-minion-dev5"
                    }
                }
             }
        }
   ],
    "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
          "title": "actions",
            "href": "actions?where={\"action\":\"cmd.run\"}&sort=-_created"
        }
    },
   "_meta": {
       "page": 1,
        "max_results": 25,
       "total": 2
    }
}

GET

/api/actions/{id}

Получение выполненного действия по id

Запрос

Параметры запроса:

Name	In	Type	Description
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.

Пример запроса:

curl -X GET http://tkcontrol/api/actions/20200508145312937405skupov-salt-minion-dev5

Ответ

Пример ответа:

{
   "_id": "20200508145312937405skupov-salt-minion-dev5",
   "jid": "20200508145312937405",
    "action": "cmd.run",
    "host": "skupov-salt-minion-dev5",
    "state": "finished",
    "args": [
         {
            "cmd": "ip a",
            "__kwarg__": true
        }
     ],
    "_updated": "Fri, 08 May 2020 11:58:51 GMT",
    "_created": "Fri, 08 May 2020 11:58:51 GMT",
    "return": "1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdis ...",
    "_links": {
    "self": {
            "title": "Action",
            "href": "actions/20200508145312937405skupov-salt-minion-dev5"
        },
        "related": {
          "host": {
               "title": "Host",
                "href": "hosts/skupov-salt-minion-dev5"
            }
       },
        "parent": {
          "title": "home",
            "href": "/"
        },
        "collection": {
            "title": "actions",
            "href": "actions"
        }
    }
}