Настройка обязанности нод кластера: различия между версиями

Текущая версия от 16:20, 25 декабря 2024

Установка и настройка / Основные элементы АппОптима / АппОптима / 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://myАппОптима.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://myАппОптима.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

@@ Строка 1: / Строка 1: @@
+'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Кластер / Настройка обязанности нод кластера'''''
 Этот запрос API настраивает обязанности узлов кластера.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
+Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/v1.0/onpremise/cluster/configuration</code>
@@ Строка 70: / Строка 72: @@
 == Ответ ==
-=== Код ответа ===
+=== Коды ответа ===
 {| class="wikitable"
 !Код
@@ Строка 80: / Строка 82: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "clusterNodes": [
       {
@@ Строка 90: / Строка 92: @@
       }
     ]
-  }</code>
+  }
 ==Пример==
 В этом примере мы отключаем трафик веб-интерфейса на '''ноде 1'''. Состояние операции можно проверить с помощью API-вызова '''Получить текущее состояние конфигурации узлов кластера'''.
 ====Curl====
-  <code>curl -X POST "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki>" -H  "accept: */*" -H  "Content-Type: application/json" -d "{\"clusterNodes\":[{\"id\":1,\"ipAddress\":\"10.10.4.2\",\"webUI\":false,\"agent\":true,\"datacenter\":\"datacenter-1\",\"kubernetesRole\":\"\"}]}"</code>
+  <code>curl -X POST "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki>" -H  "accept: */*" -H  "Content-Type: application/json" -d "{\"clusterNodes\":[{\"id\":1,\"ipAddress\":\"10.10.4.2\",\"webUI\":false,\"agent\":true,\"datacenter\":\"datacenter-1\",\"kubernetesRole\":\"\"}]}"</code>
 ====URL-адрес запроса====
-  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki></code>
 ====Тело запроса====
-  <code>{
+  <{
     "clusterNodes": [
       {
@@ Строка 110: / Строка 112: @@
       }
     ]
-  }</code>
+  }
 ==== Тело ответа ====
-  <code>{
+  <{
     "lockAcquired": true,
     "acquirationTime": 1619771074449,
     "notAcquiredReason": null
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>