Нет описания правки |
(Отмена правки 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 | <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/ | <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/cluster</nowiki></code> | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
<code> | <code>[ | ||
{ | |||
"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": [ | |||
"<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>" | ||
" | ], | ||
"communicationUris": [ | |||
"<nowiki>http://ip-10-10-4-2.eu-west-1.compute.internal:8020/communication</nowiki>", | |||
" | "<nowiki>http://10.176.42.242:8020/communication</nowiki>" | ||
" | ] | ||
} | }, | ||
... | |||
]</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