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

Текущая версия от 08:52, 26 декабря 2024

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

Этот запрос API возвращает информацию о нодах кластера.

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

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

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

/api/v1.0/onpremise/cluster

Параметры

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

Ответ

Коды ответа

Код	Тип	Описание
200	Cluster[]	Success

Объекты тела ответа

Объект `ResponseBody`

Объект не предоставляет никаких параметров.

Объект `Cluster`

Элемент	Тип	Описание
id	integer	ID ноды
clusterMemberAddress	string	Адрес члена кластера
operationState	string	Рабочее состояние
buildVersion	string	Версия сервера
osInfo	string	Информация об ОС
jvmInfo	string	Информация о JVM
dnsEntryPointUris	string[]	URI точки входа DNS
restServiceRootUris	string[]	Корневые URI службы REST
communicationUris	string[]	Коммуникационные URI

JSON-модель тела ответа

<[
  {
    "id": 1,
    "clusterMemberAddress": "string",
    "operationState": "string",
    "buildVersion": "string",
    "osInfo": "string",
    "jvmInfo": "string",
    "dnsEntryPointUris": [
      "string"
    ],
    "restServiceRootUris": [
      "string"
    ],
    "communicationUris": [
      "string"
    ]
  }
]

Пример

В этом примере запрос запрашивает у кластера текущую конфигурацию и состояние развертывания. Затем кластер возвращает информацию о каждом узле кластера в массиве. Затем каждый объект узла кластера содержит свой идентификатор, статус, адреса связи и сведения о среде хоста.

Curl

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

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

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

Тело ответа

<[
  {
    "id": 1,
    "clusterMemberAddress": "10.10.4.2:5701",
    "operationState": "RUNNING",
    "buildVersion": "1.216.10.20210429-124335",
    "osInfo": "Platform: Linux, Version: 5.4.0-1041, Architecture: amd64, Processors: 16",
    "jvmInfo": "VM: OpenJDK 64-Bit Server VM, Version: 11.0.8, Vendor: AdoptOpenJDK, Memory [maxMemory=17408M, initHeap=17408M, maxHeap=17408M, usedMeta=17M, committedMeta=17M, totalPhysicalMemory=62851M, freePhysicalMemory=14336M]",
    "dnsEntryPointUris": [],
    "restServiceRootUris": [
      "https://ip-10-10-4-2.eu-west-1.compute.internal:8021/api/v1.0",
      "https://10.10.4.2:8021/api/v1.0"
    ],
    "communicationUris": [
      "http://ip-10-10-4-2.eu-west-1.compute.internal:8020/communication",
      "http://10.176.42.242:8020/communication"
    ]
  },

  ...

]

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''[https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0 Установка и настройка] / [https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0#.D0.9E.D1.81.D0.BD.D0.BE.D0.B2.D0.BD.D1.8B.D0.B5_.D1.8D.D0.BB.D0.B5.D0.BC.D0.B5.D0.BD.D1.82.D1.8B_.D0.9A.D0.BB.D1.8E.D1.87-.D0.90.D1.81.D1.82.D1.80.D0.BE.D0.BC Основные элементы Ключ-Астром] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed Ключ-АСТРОМ Managed] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed#REST_API REST API] / [[API Кластера v1]]'''''
+'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Кластер / Информация о нодах кластера'''''
 Этот запрос API возвращает информацию о нодах кластера.
@@ Строка 74: / Строка 74: @@
 === JSON-модель тела ответа ===
-  <code>[
+  <[
     {
       "id": 1,
@@ Строка 92: / Строка 92: @@
       ]
     }
-  ]</code>
+  ]
 == Пример ==
@@ Строка 98: / Строка 98: @@
 ==== Curl ====
-  <code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster</nowiki>" -H  "accept: application/json"</code>
+  <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster</nowiki>" -H  "accept: application/json"</code>
 ==== URL-адрес запроса ====
-  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/cluster</nowiki></code>
 ==== Тело ответа ====
-  <code>[
+  <[
     {
       "id": 1,
@@ Строка 125: / Строка 125: @@
     ...
-  ]</code>
+  ]
 ==== Код ответа ====
 <code>200</code>