Перейти к основному содержимому
Версия: 8.4

Управление компонентами КЕ

Обновление компонента КЕ

PUT /api/public/sm/v2/rsm/config-items/components

Запрос возвращает модель обновленного компонента КЕ.

Тело запроса

{
"id": 0,
"configItemId": 0,
"name": "name",
"signalHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"edgeHealth": {
"type": "Direct",
"weight": 100,
"threshold": 100
},
"configItemHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"comboHealth": {
"enabled": false,
"count": 1,
"threshold": 3,
"countType" "Static"
}
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
idintegerнетnullИдентификатор компонента КЕ
configItemIdintegerданетИдентификатор КЕ
namestringданетНазвание компонента
signalHealthobjectданетПараметры для расчёта здоровья по сигналу
edgeHealthobjectданетПараметры расчёта здоровья по связи влияния
configItemHealthobjectданетПараметры расчёта здоровья на КЕ
comboHealthobjectданетПараметры расчёта здоровья через комбо-влияние

image

Коды ответа

Код ответаОписание
403Недостаточно прав для изменения КЕ
404Не найдена КЕ, связанная с компонентом
404Компонент не найден

Пакетное обновление компонентов КЕ

PUT /api/public/sm/v2/rsm/config-items/components/batch

Запрос возвращает список моделей обновленных компонентов КЕ.

Тело запроса

[{
"configItemId": 0,
"name": "name",
"signalHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"edgeHealth": {
"type": "Direct",
"weight": 100,
"threshold": 100
},
"configItemHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"comboHealth": {
"enabled": false,
"count": 1,
"threshold": 3,
"countType": "Static"
}
}]

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
idintegerнетnullИдентификатор компонента КЕ
configItemIdintegerданетИдентификатор КЕ
namestringданетНазвание компонента
signalHealthobjectнетnullПараметры для расчёта здоровья по сигналу
edgeHealthobjectнетnullПараметры расчёта здоровья по связи влияния
configItemHealthobjectнетnullПараметры расчёта здоровья на КЕ
comboHealthobjectнетnullПараметры расчёта здоровья через комбо-влияние

image

Коды ответа

Код ответаОписание
403Недостаточно прав для изменения КЕ
404Не найдена КЕ, связанная с компонентом
404Компонент не найден

Частичное обновление компонента КЕ

PATCH /api/public/sm/v2/rsm/config-items/components

Запрос возвращает модель обновленного компонента КЕ.

Тело запроса

{
"id": 0,
"configItemId": 0,
"name": "name",
"signalHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"edgeHealth": {
"type": "Direct",
"weight": 100,
"threshold": 100
},
"configItemHealth": null,
"comboHealth": {
"enabled": false,
"count": 1,
"threshold": 3,
"countType": "Static"
}
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
idintegerнетnullИдентификатор компонента КЕ
configItemIdintegerданетИдентификатор КЕ
namestringданетНазвание компонента
signalHealthobjectнетnullПараметры для расчёта здоровья по сигналу
edgeHealthobjectнетnullПараметры расчёта здоровья по связи влияния
configItemHealthobjectнетnullПараметры расчёта здоровья на КЕ
comboHealthobjectнетnullПараметры расчёта здоровья через комбо-влияние

image

Коды ответа

Код ответаОписание
403Недостаточно прав для изменения КЕ
404Не найдена КЕ, связанная с компонентом
404Компонент не найден

Пакетное частичное обновление компонентов КЕ

PATCH /api/public/sm/v2/rsm/config-items/components/batch

Запрос возвращает список моделей обновленных компонентов КЕ.

Тело запроса

[{
"id": 0,
"configItemId": 0,
"name": "name",
"signalHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"edgeHealth": {
"type": "Direct",
"weight": 100,
"threshold": 100
},
"configItemHealth": {
"type": "Weight",
"weight": 100,
"threshold": 100
},
"comboHealth": {
"enabled": false,
"count": 1,
"threshold": 3,
"countType": "Static"
}
}]

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
idintegerнетnullИдентификатор компонента КЕ
configItemIdintegerданетИдентификатор КЕ
namestringданетНазвание компонента
signalHealthobjectнетnullПараметры для расчёта здоровья по сигналу
edgeHealthobjectнетnullПараметры расчёта здоровья по связи влияния
configItemHealthobjectнетnullПараметры расчёта здоровья на КЕ
comboHealthobjectнетnullПараметры расчёта здоровья через комбо-влияние

image

Коды ответа

Код ответаОписание
403Недостаточно прав для изменения КЕ
404Не найдена КЕ, связанная с компонентом
404Компонент не найден