GET Discovery Information

サーバーにデプロイされている MATLAB 関数を検出する

説明

GET メソッドを使用して、サーバーにデプロイした MATLAB^® 関数に関する情報を表示します。以下に関する情報が返されます。

デプロイされているすべてのアーカイブとディスカバリー情報。
各アーカイブに含まれている MATLAB 関数の名前。
各 MATLAB 関数の入出力の名前と MATLAB データ型。
追加のメタデータ。

ディスカバリー情報を含めずにデプロイ可能なアーカイブ (CTF ファイル) をビルドした場合は、検出できません。

ディスカバリーサービスを使用するには、サーバーでディスカバリーサービスを有効にする必要があります。そうするには、main_config サーバー構成ファイルでオプション --enable-discovery のコメントを解除します。

リクエスト

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 で導入