Состояние конфигурации нод кластера: различия между версиями

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

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Кластер / Состояние конфигурации нод кластера

Этот вызов API возвращает текущее состояние конфигурации нод кластера.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/v1.0/onpremise/cluster/configuration/status

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответа

Код	Описание
200	Success

Пример

В этом примере мы проверяем все статусы операции реконфигурации ноды. Например, когда мы отключили трафик веб-интерфейса, или включали трафик ЕдиногоАгента.

Curl

curl -X GET "https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster/configuration" -H  "accept: */*"

URL-адрес запроса

https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster/configuration/status

Тело ответа

<[
  {
    "id": 1619771074449,
    "request": {
      "clusterNodes": [
        {
          "id": 1,
          "ipAddress": "10.10.4.2",
          "webUI": false,
          "agent": true,
          "datacenter": "datacenter-1",
          "kubernetesRole": ""
        }
      ]
    },
    "state": "SUCCESS",
    "details": "",
    "requestedAt": "2021/04/30 08:24:34 Etc/UTC",
    "finishedAt": "2021/04/30 08:25:50 Etc/UTC",
    "states": {
      "DOMAIN_UPDATE": {
        "id": 0,
        "request": null,
        "state": "SUCCESS",
        "details": "",
        "requestedAt": "2021/04/30 08:25:13 Etc/UTC",
        "finishedAt": "2021/04/30 08:25:41 Etc/UTC",
        "states": {}
      },
      "OPERATION_STATE": {
        "id": 0,
        "request": null,
        "state": "SUCCESS",
        "details": "Update operation state step finished",
        "requestedAt": "2021/04/30 08:25:41 Etc/UTC",
        "finishedAt": "2021/04/30 08:25:41 Etc/UTC",
        "states": {}
      },
      "AGENT_TRAFFIC": {
        "id": 0,
        "request": null,
        "state": "SUCCESS",
        "details": "Update agent traffic step finished",
        "requestedAt": "2021/04/30 08:25:41 Etc/UTC",
        "finishedAt": "2021/04/30 08:25:50 Etc/UTC",
        "states": {}
      },
      "WEB_UI": {
        "id": 0,
        "request": null,
        "state": "SUCCESS",
        "details": "Update web step finished",
        "requestedAt": "2021/04/30 08:24:36 Etc/UTC",
        "finishedAt": "2021/04/30 08:25:13 Etc/UTC",
        "states": {}
      }
    }
  }
]

Код ответа

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/status</code>
@@ Строка 19: / Строка 21: @@
 В этом примере мы проверяем все статусы операции реконфигурации ноды. Например, когда мы отключили трафик веб-интерфейса, или включали трафик ЕдиногоАгента.
 ====Curl====
-  <code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki>" -H  "accept: */*"</code>
+  <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki>" -H  "accept: */*"</code>
 ====URL-адрес запроса====
-  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration/status</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster/configuration/status</nowiki></code>
 ====Тело ответа====
-  <code>[
+  <[
     {
       "id": 1619771074449,
@@ Строка 81: / Строка 83: @@
       }
     }
-  ]</code>
+  ]
 ====Код ответа====
 <code>200</code>