Слияние кода завершено, страница обновится автоматически
| Версия | Время обновления | Автор |
|---|---|---|
| 1.0 | 2021-06-01 | huanxiong@dtstack.com |
api/v1/agent/install
POST
| Параметр | Тип | Описание | Требуется |
|---|---|---|---|
| collectorId | string | sidecar UUID | Да |
| configurationPath | string | путь к конфигурации агента | Нет |
| binaryPath | string | файл бинарного файла агента | Да |
| name | string | имя агента | Да |
| parameter | string | параметры агента, более одного параметра разделяются символом «,» | Нет |
| installScript | string | скрипт установки | Да |
| timeout | string | время ожидания выполнения скрипта установки по умолчанию 15 минут | Нет |
| runUser | string | пользователь для запуска агента, по умолчанию пользователь sidecar | Нет |
| installParameter | string | параметр скрипта установки | Нет |
| healthShell | string | проверка работоспособности | Нет |
| healthPeriod | string | период проверки работоспособности, 1 с, 1 м, 1 ч и т. д. | Нет |
| healthTimeout | string | время ожидания проверки работоспособности по умолчанию 20 секунд | Нет |
{
"msg": "ok",
"code": 0,
"data": {
"agent_id": "****************",
"operation_seq": 12
}
}
Описание
| Значение | Тип | Описание |
|---|---|---|
| data.agent_id | string | UUID агента |
| data.operation_seq | int | последовательность операций |
api/v1/agent/{agent_id}/uninstall
POST
| Параметр | Тип | Описание |
|---|---|---|
| parameter | string | параметры shellScript, разделенные символом «,» |
| shellScript | string | запуск shellScript для очистки при необходимости |
{
"msg": "ok",
"code": 0,
"data": {
"agent_id": "****************",
"opration_seq": 12
}
}
Описание
| Значение | Описание |
|---|---|
| data.agent_id | |
| data.opration_seq |
api/v1/agent/{agent_id}/start
api/v1/agent/{agent_id}/stop
api/v1/agent/{agent_id}/restart
GET
| Параметр | Тип | Описание |
|---|---|---|
| agent_id | string | UUID агента |
{
"msg": "ok",
"code": 0,
"data": {
"agent_id": "****************",
"opration_seq": 12
}
}
Описание
| Value | Description |
|---|---|
| data.agent_id | UUID агента |
| data.opration_seq | последовательность операций |
api/v1/agent/{agent_id}/config
GET
| Параметр | Тип | Описание |
|---|---|---|
| agent_id | string | UUID агента |
{
"msg": "ok",
"code": 0,
"data": {
"agent_id": "****************",
"config_content": "это содержимое конфигурации!"
}
}
Описание
| Значение | Тип | Описание |
|---|---|---|
| data.agent_id | string | UUID агента |
| data.config_content | string | содержимое конфигурации агента |
api/v1/agent/{agent_id}/config
POST
| Параметр | Тип | Описание |
|---|---|---|
| agent_id | string | UUID агента |
| config_content | string | контекст конфигурации агента |
{
"msg": "ok",
"code": 0,
"data": {
"agent_id": "****************",
"opration_seq": 12
}
}
Описание
| Value | Type | Description |
|---|---|---|
| data.agent_id | string | UUID агента |
| data.opration_seq | последовательность операций |
api/v1/sidecar/{sidecar_id:uuid}/execscript
POST
| Параметр | Тип | Описание |
|---|---|---|
| execScript | string | содержание скрипта |
| parameter | string | Params, разделенные символом «,» |
| timeout | string | длительность в виде последовательности десятичных чисел, каждое с необязательной дробью и суффиксом единицы измерения, например, «300 мс», «-1,5 ч» или «2 ч 45 м». Допустимые единицы времени: «нс», «мкс» (или «мкc»), «мс», «с», «м», «ч». |
{
"msg": "ok",
"code": 0,
"data": {
"sidecar_id": "****************",
"operation_seq": 12
}
}
Описание ## Получение прогресса операции по seq и agentId
api/v1/agent/{agent_id}/progress
GET
| Параметр | Тип | Описание |
|---|---|---|
| agent_id | string | UUID агента |
| operation_seq | int |
{
"msg": "ok",
"code": 0,
"data": {
"operation_seq": 23,
"op_time": "2017-07-28T15:45:32",
"op_name": "install",
"progress": 0.24,
"op_result": 0,
"ret_msg": "",
"msg": "",
"finish_time": "2017-07-28T16:45:32",
"ts": "2017-07-28T16:45:32",
"collector_id": "sdasdecaccrsdaaa",
"agent_id": "cskdfmpoervmkef"
}
}
Описание: | Значение | Тип | Описание | |----------|-------|----------| | data.operation_seq | int | UUID операции установки | | data.op_time | date | Время начала операции установки | | data.op_name | string | Название операции установки | | data.progress | float | Прогресс операции установки | | data.op_result | int | 0 — успех, 1 — сбой | | data.ret_msg | string | Сообщение возврата оболочки установки | | data.msg | string | Результат сообщения | | data.finish_time | date | Время завершения операции | | data.ts | date | Отметка времени прогресса | | data.collector_id | string | UUID сайдкара | | data.agent_id | string | UUID агента |
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )