ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
''''' | '''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Кластер / Настройка обязанности нод кластера''''' | ||
Этот запрос API настраивает обязанности узлов кластера. | Этот запрос API настраивает обязанности узлов кластера. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/v1.0/onpremise/cluster/configuration</code> | <code>/api/v1.0/onpremise/cluster/configuration</code> | ||
| Строка 82: | Строка 82: | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"clusterNodes": [ | "clusterNodes": [ | ||
{ | { | ||
| Строка 101: | Строка 101: | ||
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki></code> | <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki></code> | ||
====Тело запроса==== | ====Тело запроса==== | ||
< | <{ | ||
"clusterNodes": [ | "clusterNodes": [ | ||
{ | { | ||
| Строка 115: | Строка 115: | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
< | <{ | ||
"lockAcquired": true, | "lockAcquired": true, | ||
"acquirationTime": 1619771074449, | "acquirationTime": 1619771074449, | ||
Версия от 13:18, 8 ноября 2024
Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Кластер / Настройка обязанности нод кластера
Этот запрос API настраивает обязанности узлов кластера.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/v1.0/onpremise/cluster/configuration
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| body | ClusterNodesConfigDto | - | body | Нет |
Объекты тела запроса
Объект ClusterNodesConfigDto
| Элемент | Тип | Описание | Обязательно |
|---|---|---|---|
| clusterNodes | NodeConfigDto[] | - | Нет |
Объект NodeConfigDto
| Элемент | Тип | Описание | Обязательно |
|---|---|---|---|
| id | integer | - | Нет |
| webUI | boolean | - | Нет |
| agent | boolean | - | Нет |
| datacenter | string | - | Нет |
| kubernetesRole | string | - | Нет |
Ответ
Коды ответа
| Код | Описание |
|---|---|
| 200 | Success |
JSON-модель тела ответа
<{
"clusterNodes": [
{
"id": 1,
"webUI": true,
"agent": true,
"datacenter": "string",
"kubernetesRole": "string"
}
]
}
Пример
В этом примере мы отключаем трафик веб-интерфейса на ноде 1. Состояние операции можно проверить с помощью API-вызова Получить текущее состояние конфигурации узлов кластера.
Curl
curl -X POST "https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration" -H "accept: */*" -H "Content-Type: application/json" -d "{\"clusterNodes\":[{\"id\":1,\"ipAddress\":\"10.10.4.2\",\"webUI\":false,\"agent\":true,\"datacenter\":\"datacenter-1\",\"kubernetesRole\":\"\"}]}"
URL-адрес запроса
https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration
Тело запроса
<{
"clusterNodes": [
{
"id": 1,
"ipAddress": "10.10.4.2",
"webUI": false,
"agent": true,
"datacenter": "datacenter-1",
"kubernetesRole": ""
}
]
}
Тело ответа
<{
"lockAcquired": true,
"acquirationTime": 1619771074449,
"notAcquiredReason": null
}
Код ответа
200