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

Материал из Документация Ключ-АСТРОМ
(Отмена правки 1256, сделанной RGolovanov (обсуждение))
Метка: отмена
Строка 15: Строка 15:
{| class="wikitable"
{| class="wikitable"
!Код
!Код
|'''Тип'''
!Описание
!Описание
|-
|-
|'''200'''
|'''200'''
|Cluster[]
|Success
|Success
|}
|}
=== Объекты тела ответа ===
==== Объект <code>ResponseBody</code> ====
Объект не предоставляет никаких параметров.
==== Объект <code>Cluster</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|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-модель тела ответа ===
<code>[
  {
    "id": 1,
    "clusterMemberAddress": "string",
    "operationState": "string",
    "buildVersion": "string",
    "osInfo": "string",
    "jvmInfo": "string",
    "dnsEntryPointUris": [
      "string"
    ],
    "restServiceRootUris": [
      "string"
    ],
    "communicationUris": [
      "string"
    ]
  }
]</code>


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


==== Curl ====
==== 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://myManaged.cluster.com/api/v1.0/onpremise/cluster</nowiki>" -H  "accept: application/json"</code>


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</code>
  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster</nowiki></code>


==== Тело ответа ====
==== Тело ответа ====
  <code>{
  <code>[
   "clusterNodes": [
   {
     {
     "id": 1,
      "id": 1,
    "clusterMemberAddress": "10.10.4.2:5701",
      "ipAddress": "10.10.4.2",
    "operationState": "RUNNING",
      "webUI": false,
    "buildVersion": "1.216.10.20210429-124335",
      "agent": true,
    "osInfo": "Platform: Linux, Version: 5.4.0-1041, Architecture: amd64, Processors: 16",
      "datacenter": "datacenter-1",
    "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]",
      "kubernetesRole": ""
     "dnsEntryPointUris": [],
     },
     "restServiceRootUris": [
     {
       "<nowiki>https://ip-10-10-4-2.eu-west-1.compute.internal:8021/api/v1.0</nowiki>",
       "id": 2,
       "<nowiki>https://10.10.4.2:8021/api/v1.0</nowiki>"
       "ipAddress": "10.10.4.6",
    ],
      "webUI": true,
    "communicationUris": [
      "agent": false,
       "<nowiki>http://ip-10-10-4-2.eu-west-1.compute.internal:8020/communication</nowiki>",
       "datacenter": "datacenter-1",
       "<nowiki>http://10.176.42.242:8020/communication</nowiki>"
       "kubernetesRole": ""
     ]
     }
  },
  }</code>
   
  ...
]</code>


==== Код ответа ====
==== Код ответа ====
<code>200</code>
<code>200</code>

Версия 15:36, 16 сентября 2022

Этот запрос 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://myManaged.cluster.com/api/v1.0/onpremise/cluster" -H  "accept: application/json"

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

https://myManaged.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

Источник — https://doc.ruscomtech.ru/index.php?title=Информация_о_нодах_кластера&oldid=1257