Перейти к основному содержимому

Поиск контроллеров API 1.7.0

Методы API для работы с разделом «Поиск контроллеров».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/controller_search
GET/controller_search/status

Раздел: Поиск контроллеров.

Возвращает результат поиска контроллера

Источник в Teamly

Назначение

URL запроса

Возвращает результат поиска контроллера

https://{IP_контроллера}/api/v1/controller_search

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully returned search results) - удачное выполнение запроса

Название, * - обязательный

Тип

Формат

Назначение

address*

string

IP-адрес контроллера

udn*

string

Уникальный идентификатор контроллера (например, "uuid:7537abe7-e9e7-4170-0000-000000000536")

name*

string

Название контроллера

serial*

string

Серийный номер контроллера

description*

string

Описание контроллера

model*

string

Модель контроллера

Пример:

[
  {
    "address": "string",
    "udn": "string",
    "name": "string",
    "serial": "string",
    "description": "string",
    "model": "string"
  }
]

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI
{
  "description": "Get controllers search results",
  "responses": {
    "200": {
      "description": "Successfully returned search results",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "address",
                "udn",
                "name",
                "searial",
                "description",
                "model"
              ],
              "properties": {
                "address": {
                  "type": "string"
                },
                "udn": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "serial": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "model": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>"

Пример ответа​

[
  {
    "address": "string",
    "udn": "string",
    "name": "string",
    "serial": "string",
    "description": "string",
    "model": "string"
  }
]

GET /controller_search/status​

Раздел: Поиск контроллеров.

Возвращает статус поиска контроллеров

Источник в Teamly

Назначение

URL запроса

Возвращает статус поиска контроллеров

https://{IP_контроллера}/api/v1/controller_search/status

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

Пример:

Пример с исправленным синтаксисом JSON

Добавлена закрывающая фигурная скобка.

{
  "status": "STOPPED"
}
Исходный пример Teamly

Пример из Teamly сохранён дословно, но не является корректным JSON.

{
  "status": "STOPPED"

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI
{
  "description": "Get controllers search status",
  "responses": {
    "200": {
      "description": "Successfully received search status",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "status"
            ],
            "properties": {
              "status": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/controller_search/status" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "status": "string"
}