GET Discovery Information

Обнаружение функций MATLAB, развернутых на сервере

Описание

Используйте метод GET для просмотра информации о MATLAB® функций, которые вы развертываете на сервере. Вы получаете информацию о

  • все развернутые архивы с информацией об обнаружении.

  • имена функций MATLAB, содержащихся в каждом архиве.

  • имена и типы данных MATLAB входов и выходов для каждой функции MATLAB.

  • дополнительные метаданные.

Если вы создаете развертываемый архив (CTF файл), не включая информацию об обнаружении, она не может быть обнаружена.

Для порядка использования службы обнаружения необходимо включить службу обнаружения на сервере. Сделайте это, отключив опцию --enable-discovery в main_config файл строения сервера.

Запрос

Метод HTTP

GET

URI

http://host:port/api/discovery

Ответ

Успех

Код состояния HTTP

200 OK

Тело

Описание тела смотрите в JSON Response Object.

Ошибка

403 DiscoveryDisabled

Пример вызова

HTTP

Запрос:

GET /api/discovery HTTP/1.1
Host: localhost:9910

Ответ:

{
    "discoverySchemaVersion": "1.0.0",
    "archives": {
        "mymagic": {
            "archiveSchemaVersion": "1.1.0",
            "archiveUuid": "mymagic_73BCCE8B5FFFB984888169285CBA8A31",
            "name": "mymagic"
            "matlabRuntimeVersion": "9.5.0"
            
            "functions": {
                "mymagic": {
                    "signatures": [
                        {
                            "help": "Generate a magic square", 
                            "inputs": [
                                {
                                    "name": "in",
                                    "mwtype": "double",
                                    "mwsize": [],
                                    "help": "Dimension of magic square matrix"                                    
                                }
                            ],
                            "outputs": [
                                {
                                    "name": "out",
                                    "mwtype": "double",
                                    "mwsize": [],
                                    "help": "Magic square matrix"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    }
}

JavaScript

var data = null;
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://localhost:9910/api/discovery");
xhr.send(data);

Введенный в R2018a
Для просмотра документации необходимо авторизоваться на сайте