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

Материал из Документация Ключ-АСТРОМ
Строка 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</nowiki>" -H  "accept: application/json"</code>
  <code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration</nowiki>" -H  "accept: */*"</code>


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


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


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

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

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

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

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

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

/api/v1.0/onpremise/cluster

Параметры

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

Ответ

Коды ответа

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

Пример

Этот запрос возвращает все узлы с их значениями возможностей узлов и назначением центра обработки данных.

Curl

curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration" -H  "accept: */*"

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": ""
    },
    {
      "id": 2,
      "ipAddress": "10.10.4.6",
      "webUI": true,
      "agent": false,
      "datacenter": "datacenter-1",
      "kubernetesRole": ""
    }
}

Код ответа

200