C.1 HTTP API

C.1.0.1 基本情報

  • BASEURL: /api

C.1.0.2 ヘッダー

  • iotbox-token: IOTBOX-TOKEN

C.1.0.3 戻りコード

code 説明
200 コンテンツ付きの成功戻り
204 コンテンツなしの成功戻り
499 収集エラー
498 読み取りエラー
497 書き込みエラー
496 ファイルが見つかりません
496 設定復元エラー
494 更新エラー
493 パスワードエラー
492 ユーザーが無効になっています
491 レコード重複
490 スクリプトチェックエラー
489 JSON形式エラー
450 その他のエラー
404 リソースが見つかりません
401 ログインしていません
400 パラメータエラー

C.1.1 ユーザー

C.1.1.1 ログイン

項目 内容 備考
URL /user/login
Method POST
  • リクエストパラメータ
{
    "password":"password",
    "username":"admin"
}
  • 戻り例
{
    "token":"12599b49f6ab6b3abec7d32b3922e9d9"
}

C.1.1.2 ログアウト

項目 内容 備考
URL /user/login
Method DELETE

C.1.1.3 ログアウト

項目 内容 備考
URL /user/login
Method DELETE

C.1.1.4 INFO

項目 内容 備考
URL /user/info
Method GET
  • 戻り例
{
    "fingerprint": "3f7d0134a560d0393008b984fef2b936",
    "hardware": "DEVDEVICE",
    "id": 2,
    "lisence": {
        "count": {
            "all": 11
        },
        "exp": 4100688000,
        "fingerprint": "3f7d0134a560d0393008b984fef2b936",
        "vpn": false
    },
    "role": 2,
    "software": "2.0.20220509",
    "username": "admin"
}

C.1.1.5 パスワード変更

項目 内容 備考
URL /user/change_password
Method PUT
  • リクエストパラメータ
{
    "password":"password",
    "new_password":"new_password"
}

C.1.2 デバイス

C.1.2.1 デバイスリスト

項目 内容 備考
URL /device
Method GET
Query keywords: デバイス名でデバイスをクエリ

  • 戻り例

    [
    {
        "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend",
        "config": {
            "host": "192.168.9.207",
            "port": 8193
        },
        "enable": true,
        "id": 1,
        "interval": 20,
        "model": "default",
        "name": "D001",
        "state": 0,
        "type": "fanuc"
    }
]

C.1.2.2 デバイス追加

項目 内容 備考
URL /device
Method POST

  • リクエストパラメータ

    {
    "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend",
    "config": {
        "host": "192.168.9.207",
        "port": 8193
    },
    "enable": true,
    "interval": 20,
    "model": "default",
    "name": "D001",
    "state": 0,
    "type": "fanuc"
}

  • 戻り例`

    {
    "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend",
    "config": {
        "host": "192.168.9.207",
        "port": 8193
    },
    "enable": true,
    "id": 1,
    "interval": 20,
    "model": "default",
    "name": "D001",
    "state": 0,
    "type": "fanuc"
}

C.1.2.3 デバイス取得

項目 内容 備考
URL /device/<id> idはデバイスIdです
Method GET

  • 戻り例`

    {
    "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend",
    "config": {
        "host": "192.168.9.207",
        "port": 8193
    },
    "enable": true,
    "id": 1,
    "interval": 20,
    "model": "default",
    "name": "D001",
    "type": "fanuc",
    "variables": [
        {
            "calc": "",
            "config": {
                "builtin": true
            },
            "id": 8,
            "name": "cnc_type",
            "readable": true,
            "writable": false
        }
    ]
}

C.1.2.4 デバイス変更

項目 内容 備考
URL /device/<id> idはデバイスIdです
Method PUT

  • リクエストパラメータ`

    {
    "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend",
    "config": {
        "host": "192.168.9.207",
        "port": 8193
    },
    "enable": true,
    "id": 1,
    "interval": 20,
    "model": "default",
    "name": "D001",
    "type": "fanuc",
    "variables": [
        {
            "calc": "",
            "config": {
                "builtin": true
            },
            "id": 8,
            "name": "cnc_type",
            "readable": true,
            "writable": false
        }
    ]
}

  • 戻り例`

    {
    "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend",
    "config": {
        "host": "192.168.9.207",
        "port": 8193
    },
    "enable": true,
    "id": 1,
    "interval": 20,
    "model": "default",
    "name": "D001",
    "type": "fanuc",
    "variables": [
        {
            "calc": "",
            "config": {
                "builtin": true
            },
            "id": 8,
            "name": "cnc_type",
            "readable": true,
            "writable": false
        }
    ]
}

C.1.2.5 デバイス削除

項目 内容 備考
URL /device/<id> idはデバイスIdです
Method DELETE

C.1.2.6 デバイスデータOBJECT取得

項目 内容 備考
URL /device/<id>/info query keyがcodeの場合、idはデバイス番号、それ以外の場合はidはデバイスidです
Method GET
Query key:idタイプ
type: データタイプを選択
    before_item_calc 変数計算前
    before_device_calc デバイス計算前

  • 戻り例

    {
    "cnc_type": {
        "id": 8,
        "ts": 1652085617619,
        "value": "FANUC 0i MF"
    },
    "cnc_actfspeed": {
        "id": 27,
        "ts": 1652085617763,
        "value": 0
    },
}

C.1.2.7 デバイスデータLIST取得

項目 内容 備考
URL /device/<id>/info_array query keyがcodeの場合、idはデバイス番号、それ以外の場合はidはデバイスidです
Method GET
Query key:idタイプ
type: データタイプを選択
    before_item_calc 変数計算前
    before_device_calc デバイス計算前

  • 戻り例`

    [
    {
        "id": 20,
        "name": "cnc_tooloffsetnum",
        "ts": 1652085597698,
        "value": 0
    },
    {
        "id": 8,
        "name": "cnc_type",
        "ts": 1652085597615,
        "value": "FANUC 0i MF"
    }
]

C.1.2.8 デバイス故障チェック

項目 内容 備考
URL /device/<id>/check_health idはデバイスIdです
Method GET

  • 戻り例`

    [
    {
        "code": 90200,
        "important": false,
        "state": 0
    },
    {
        "code": 40000,
        "important": false,
        "state": 0
    },
    {
        "code": 10000,
        "important": false,
        "state": 0
    }
]

C.1.2.9 デバイス変数取得

項目 内容 備考
URL /device/<id>/variable idはデバイスIdです
Method GET
Query start: オフセット数
limit: リクエストごとの戻り数

  • 戻り例`

    [
    {
        "calc": "",
        "config": {
            "builtin": true
        },
        "id": 34,
        "name": "cnc_stemper",
        "readable": true,
        "writable": false
    }
]

C.1.2.10 デバイス変数追加

項目 内容 備考
URL /device/<id>/variable idはデバイスIdです
Method POST

  • リクエストパラメータ

    {
    "calc": "",
    "config": {
        "builtin": true
    },
    "name": "cnc_stemper",
    "readable": true,
    "writable": false
}

  • 戻り例`

    {
    "calc": "",
    "config": {
        "builtin": true
    },
    "id": 34,
    "name": "cnc_stemper",
    "readable": true,
    "writable": false
}

C.1.2.11 変数変更

項目 内容 備考
URL /variable/<id> idは変数idです
Method PUT

  • リクエストパラメータ`

    {
    "calc": "",
    "config": {
        "builtin": true
    },
    "name": "cnc_stemper",
    "readable": true,
    "writable": false
}

  • 戻り例`

    {
    "calc": "",
    "config": {
        "builtin": true
    },
    "id": 34,
    "name": "cnc_stemper",
    "readable": true,
    "writable": false
}

C.1.2.12 変数取得

項目 内容 備考
URL /variable/<id> idは変数idです
Method GET

  • 戻り例`

    {
    "calc": "",
    "config": {
        "builtin": true
    },
    "id": 34,
    "name": "cnc_stemper",
    "readable": true,
    "writable": false
}

C.1.2.13 変数削除

項目 内容 備考
URL /variable/<id> idは変数idです
Method DELETE

C.1.2.14 変数値取得

項目 説明
URL /variable/<id>/value idは変数idです
Method GET

  • 戻り例`

    {
    "ts": 1652086215825,
    "value": 123
}

C.1.2.15 変数値書き込み

項目 内容 備考
URL /variable/<id>/value idは変数idです
Method PUT

  • リクエスト例

    {
    "value": 123
}

C.1.2.16 デバイスエッジ計算テスト

項目 内容 備考
URL /device/<id>/edge_test idはデバイスIdです
Method PUT

  • リクエストパラメータ`

    {
    "current": {
        "cnc_alarm": [
            {
                "alarm_no": 1,
                "alarm_type": "T01",
                "alarm_msg": "待机中"
            },
            {
                "alarm_no": 204,
                "alarm_type": "XXX",
                "alarm_msg": "急停"
            }
        ]
    },
    "last": "",
    "calc": "function calc(value)\n    for i, v in ipairs(value.cnc_alarm) do\n        value['cnc_alarm_' .. i .. '_msg'] = v.alarm_msg\n        value['cnc_alarm_' .. i .. '_no'] = v.alarm_no\n        value['cnc_alarm_' .. i .. '_type'] = v.alarm_type\n    end\n    value.cnc_alarm = nil\n    return value\nend"
}

  • 戻り例`

    {
    "cnc_alarm_1_msg": "待机中",
    "cnc_alarm_1_no": 1,
    "cnc_alarm_1_type": "T01",
    "cnc_alarm_2_msg": "急停",
    "cnc_alarm_2_no": 204,
    "cnc_alarm_2_type": "XXX"
}

C.1.2.17 変数エッジ計算テスト

項目 内容 備考
URL /variable/<id>/edge_test idは変数idです
Method PUT

  • リクエストパラメータ`

    {
    "current": "abc",
    "last": "def",
    "calc": "function calc(current,last)\n    current=current .. \"imok\"\n    return current\nend"
}

  • 戻り例`

    {
    "result": "abcimok"
}

C.1.2.18 変数エッジ計算テスト

項目 内容 備考
URL /variable/<id>/edge_test
Method PUT

  • リクエストパラメータ`

    {
    "current": "abc",
    "last": "def",
    "calc": "function calc(current,last)\n    current=current .. \"imok\"\n    return current\nend"
}

  • 戻り例`

    {
    "result": "abcimok"
}

C.1.2.19 デバイス名と変数名で値を取得

項目 内容 備考
URL /device/<device_name>/variable/<variable_name> device_name: デバイス名
variable_name:変数名
Method GET
Query type: データタイプを選択、オプション
    before_calc 変数計算前
force: データを強制更新

  • 戻り例`

    {
    "value":123,
    "ts": 1725878881541
}

C.1.2.20 デバイス名と変数名で変数値を書き込み

項目 内容 備考
URL /device/<device_name>/variable/<variable_name> device_name: デバイス名
variable_name:変数名
Method PUT

  • 戻り例`

    {
    "value":123,
}

C.1.3 DNC

C.1.3.1 クラウドプログラムリスト取得

項目 内容 備考
URL /device/<id>/dnc/cloudend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
path: 親パス、空の場合は/
Method GET

  • 戻り例

    [
    {
        "name": "O1234",
        "kind": 1, //1はフォルダ、2はファイル
        "time": "2019-08-29 20:13:14"
        "size": 0
    }
]

C.1.3.2 クラウドプログラム削除

項目 内容 備考
URL /device/<id>/dnc/cloudend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ<br>path: プログラムパス
Method DELETE

C.1.3.3 IoTBoXプログラムリスト取得

項目 内容 備考
URL /device/<id>/dnc/boxend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
Method GET

  • 戻り例`

    [
    {
        "name": "O1234",
        "kind": 1, //1はフォルダ、2はファイル
        "time": "2019-08-29 20:13:14"
        "size": 0
    }
]

C.1.3.4 IoTBoXプログラムをクラウドにアップロード

項目 内容 備考
URL /device/<id>/dnc/boxend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
Method PUT

  • リクエスト例`

    {
    "src": "O1234", //ローカルファイル名
    "dst": "/test/path/O1234.nc"  //クラウドファイル名
}

C.1.3.5 クラウドからIoTBoXにプログラムをダウンロード

項目 内容 備考
URL /device/<id>/dnc/boxend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
Method POST

  • リクエスト例`

    {
    "dst": "O1234", //ローカルファイル名
    "src": "/test/path/O1234.nc"  //クラウドファイル名
}

C.1.3.6 IoTBoXプログラム削除

項目 内容 備考
URL /device/<id>/dnc/boxend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ<br>path: プログラムパス
Method DELETE

C.1.3.7 工作機械プログラムリスト取得

項目 内容 備考
URL /device/<id>/dnc/toolend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
path: 親パス、空の場合は/
Method GET

  • 戻り例`

    [
    {
        "name": "O1234",
        "kind": 1, //1はフォルダ、2はファイル
        "time": "2019-08-29 20:13:14"
        "size": 0
    }
]

C.1.3.8 工作機械プログラムをIoTBoXにアップロード

項目 内容 備考
URL /device/<id>/dnc/toolend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
Method PUT

  • リクエスト例`

    {
    "src": "/test/path/O1234", //工作機械ファイル名
    "dst": "O1234"  //**IoTBoX**ファイル名
}

C.1.3.9 IoTBoXから工作機械にプログラムをダウンロード

項目 内容 備考
URL /device/<id>/dnc/toolend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ
Method POST

  • リクエスト例`

    {
    "src": "O1234", //**IoTBoX**ファイル名
    "dst": "/test/path/O1234.nc"  //工作機械ファイル名
}

C.1.3.10 工作機械プログラム削除

項目 内容 備考
URL /device/<id>/dnc/toolend クエリキーがcodeの場合、idはデバイス番号、それ以外の場合、idはデバイスidです
Query key: idタイプ<br>path: プログラムパス
Method DELETE

C.1.4 バックアップ

C.1.4.1 バックアップエクスポート

項目 内容 備考
URL /system/backup
Method GET
  • バックアップファイルを返す

C.1.4.2 バックアップ復元

項目 内容 備考
URL /system/backup
Method POST
Body ファイル内容

C.1.5 設定

C.1.5.1 設定リスト取得

項目 内容 備考
URL /manager/config
Method GET
Query keywords: 名前で検索
type: typeで検索
start: オフセット数
limit: リクエストごとの戻り数

  • 戻り例`

    [
    {
        "id": 1,
        "key": "test_key",
        "meta": {},
        "name": "测试key",
        "public": false,
        "type": "system",
        "value": "test"
    }
]

C.1.5.2 設定追加

項目 内容 備考
URL /manager/config
Method POST

  • リクエスト例`

    {
    "key": "test_key",
    "meta": {},
    "name": "测试key",
    "public": false,
    "type": "system",
    "value": "test"
}

  • 戻り例`

    {
    "id": 1,
    "key": "test_key",
    "meta": {},
    "name": "测试key",
    "public": false,
    "type": "system",
    "value": "test"
}

C.1.5.3 単一設定取得

項目 内容 備考
URL /manager/config/<id> クエリキーが1の場合、idは設定名、それ以外の場合、idは設定idです
Query key: keyを使用して設定を取得するかどうか
Method GET

  • 戻り例`

    {
    "key": "test_key",
    "meta": {},
    "name": "测试key",
    "public": false,
    "type": "system",
    "value": "test"
}

C.1.5.4 単一設定取得（認証不要の公開設定）

項目 内容 備考
URL /public/config/<id> クエリキーが1の場合、idは設定名、それ以外の場合、idは設定idです
Query key: keyを使用して設定を取得するかどうか
Method GET

  • 戻り例`

    {
    "key": "test_key",
    "meta": {},
    "name": "测试key",
    "public": false,
    "type": "system",
    "value": "test"
}

C.1.5.5 設定変更

項目 内容 備考
URL /manager/config/<id> クエリキーが1の場合、idは設定名、それ以外の場合、idは設定idです
Query key: keyを使用して設定を取得するかどうか
Method PUT

  • リクエスト例`

    {
    "key": "test_key",
    "meta": {},
    "name": "测试key",
    "public": false,
    "type": "system",
    "value": "test"
}

  • 戻り例`

    {
    "id": 1,
    "key": "test_key",
    "meta": {},
    "name": "测试key",
    "public": false,
    "type": "system",
    "value": "test"
}

C.1.5.6 設定削除

項目 内容 備考
URL /manager/config/<id> クエリキーが1の場合、idは設定名、それ以外の場合、idは設定idです
Query key: keyを使用して設定を取得するかどうか
Method DELETE

C.1.6 デバッグ

C.1.6.1 デバッグコマンド

項目 内容 備考
URL /system/cmd
Method PUT

  • リクエストパラメータ`

    {
    "cmd": "ping", //可选命令ping,getip,telnet,route,reboot,restart
    "parameter": "192.168.1.3", //命令为ping参数可为ip或域名,命令为telnet时,参数为host:port
    "interface": "192.168.1.3" //命令为ping参数为网口,可为空
}

C.1.6.2 システムログ

項目 内容 備考
URL /log/debug
Method WEBSOCKET

C.1.7 IoTBoX設定

C.1.7.1 IoTBoX情報取得

項目 内容 備考
URL /gateway
Method GET

  • 戻り例`

    {
    "fingerprint": "8ea29081b4c78e7bfa539622eb0038c4",
    "hardware": "WD1ECS",
    "id": "8ea29081b4c78e7bfa539622eb0038c4",
    "ports": [
    {
            "comment": "",
            "device": "eth0",
            "enable": true,
            "name": "Ethernet",
            "type": 3
        }, {
            "comment": "",
            "device": "/dev/ttyS1",
            "enable": true,
            "name": "COM1",
            "type": 2
        }
    ],
    "software": "2.0.09090429"
}

C.1.7.2 IoTBoX情報設定

項目 内容 備考
URL /gateway
Method PUT

  • リクエスト例`

    {
    "id": "8ea29081b4c78e7bfa539622eb0038c4"
}

C.1.7.3 クラウドストレージ情報取得

項目 内容 備考
URL /dnc_config
Method GET

  • 戻り例`

    {

    "enable": true,
    "interval": 1,
    "type": "aws_s3",
    "secret_key": "SECRET_KEY", // 此配置根据type同
    "access_key": "ACCESS_KEY", // 此配置根据type同
    "api": "https:://minio.woody.vip/api" // 此配置根据type同
}

C.1.7.4 クラウドストレージ情報送信

項目 内容 備考
URL /dnc_config
Method PUT

  • リクエスト例`

    {

    "enable": true,
    "interval": 1,
    "type": "aws_s3",
    "secret_key": "SECRET_KEY", // 此配置根据type同
    "access_key": "ACCESS_KEY", // 此配置根据type同
    "api": "https:://minio.woody.vip/api" // 此配置根据type同
}

C.1.8 IoTBoXライセンス

C.1.8.1 ライセンス情報取得

項目 内容 備考
URL /lisence
Method GET
Query type: tempは一時ライセンス、それ以外は正式ライセンスです

  • 戻り例`

    {
    "count": {
        "fanuc": 3
    },
    "exp": 4100688000,
    "fingerprint": "8ea29081b4c78e7bfa539622eb0038c4",
    "vpn": true
}

C.1.8.2 ライセンス情報送信

項目 内容 備考
URL /lisence
Method PUT
Query type: tempは一時ライセンス、それ以外は正式ライセンスです

  • リクエスト例`

    {
    "lisence": "xxxxx"
}

C.1.9 ネットワーク情報

C.1.9.1 インターフェース情報取得

項目 内容 備考
URL /network/interface
Method GET

  • 戻り例`

    [
    {
        "dhcp": 0,
        "gateway": "192.168.9.1",
        "id": 1,
        "ip": [
            "192.168.9.107/24"
        ],
        "name": "eth0",
        "password": "",
        "ssid": "",
        "type": 1
    }
]

C.1.9.2 インターフェース情報変更

項目 内容 備考
URL /network/interface
Method PUT

  • リクエスト例`

    [
    {
        "dhcp": 0,
        "gateway": "192.168.9.1",
        "id": 1,
        "ip": [
            "192.168.9.107/24"
        ],
        "name": "eth0",
        "password": "",
        "ssid": "",
        "type": 1
    }
]

C.1.9.3 インターフェース追加

項目 内容 備考
URL /network/interface
Method POST

  • リクエスト例`

    {
    "dhcp": 0,
    "gateway": "192.168.9.1",
    "id": 1,
    "ip": [
        "192.168.9.107/24"
    ],
    "name": "eth0",
    "password": "",
    "ssid": "",
    "type": 1
}

C.1.9.4 インターフェース削除

項目 内容 備考
URL /network/interface/<id> idはインターフェースidです
Method DELETE

C.1.9.5 DNS情報取得

項目 内容 備考
URL /network/dns
Method GET

  • 戻り例`

    [
    "114.114.114.114",
    "8.8.8.8"
]

C.1.9.6 DNS情報変更

項目 内容 備考
URL /network/dns
Method PUT

  • リクエスト例`

    [
    "114.114.114.114",
    "8.8.8.8"
]

C.1.9.7 4G設定取得

項目 内容 備考
URL /network/4g
Method GET

  • 戻り例`

    {
    "apn": "test_apn",
    "password": "pass",
    "pincode": "1234",
    "username": "testuser"
}

C.1.9.8 4G設定変更

項目 内容 備考
URL /network/4g
Method PUT

  • リクエスト例`

    {
    "apn": "test_apn",
    "password": "pass",
    "pincode": "1234",
    "username": "testuser"
}

C.1.9.9 ルーター有効状態取得

項目 内容 備考
URL /network/router
Method GET

  • 戻り例`

    {
    "enable": true
}

C.1.9.10 有効状態変更

項目 内容 備考
URL /network/router
Method PUT

  • リクエスト例`

    {
    "enable": true
}

C.1.9.11 ルート情報取得

項目 内容 備考
URL /network/custom_route
Method GET

  • 戻り例`

    [
    {
        "net": "192.168.3.1/24",
        "via": "192.168.9.1"
    }
]

C.1.9.12 ルート情報変更

項目 内容 備考
URL /network/custom_route
Method PUT

  • リクエスト例`

    [
    {
        "net": "192.168.3.1/24",
        "via": "192.168.9.1"
    }
]

C.1.9.13 テストネットワーク情報取得

項目 内容 備考
URL /network/test_resource
Method GET

  • 戻り例`

    {
    "host": "www.jd.com",
    "ip": "114.114.114.114"
}

C.1.9.14 テストネットワーク情報変更

項目 内容 備考
URL /network/test_resource
Method PUT

  • リクエスト例`

    {
    "host": "www.jd.com",
    "ip": "114.114.114.114"
}

C.1.10 ポート転送

C.1.10.1 ポート転送リスト取得

項目 内容 備考
URL /proxy
Method GET

  • 戻り例`

    [
    {
        "id": 1,
        "id_in_server": 24,
        "ip": "192.168.9.33",
        "name": "办公电脑",
        "port": 3389,
        "proxy_port": 9081,
        "type": ""
    }
]

C.1.10.2 ポート転送追加

項目 内容 備考
URL /proxy
Method POST

  • リクエスト例`

    {
    "name": "办公电脑",
    "ip": "192.168.9.33",
    "port": 3389
}

C.1.10.3 ポート転送取得

項目 内容 備考
URL /proxy/<id> idはポート転送idです
Method GET

  • 戻り例`

    {
    "id": 1,
    "id_in_server": 24,
    "ip": "192.168.9.33",
    "name": "办公电脑",
    "port": 3389,
    "proxy_port": 9081,
    "type": ""
}

C.1.10.4 ポート転送変更

項目 内容 備考
URL /proxy/<id> idはポート転送idです
Method PUT

  • リクエスト例`

    {
    "name": "办公电脑",
    "ip": "192.168.9.33",
    "port": 3389
}

C.1.10.5 ポート転送削除

項目 内容 備考
URL /proxy/<id> idはポート転送idです
Method DELETE

C.1.11 プッシュ設定

C.1.11.1 プッシュリスト取得

項目 内容 備考
URL /publish
Method GET

  • 戻り例`

    [
    {
        "config": {
            "host": "111",
            "port": 222,
            "publisher_ssl_enable": false,
            "publisher_ssl_version": "default",
            "version": "v2"
        },
        "enable": true,
        "enable_control": true,
        "enable_publish": true,
        "id": 1,
        "interval": 1,
        "name": "aaaa",
        "type": "mqtt_common"
    }
]

C.1.11.2 プッシュ追加

項目 内容 備考
URL /publish
Method POST

  • リクエスト例`

    {
    "type": "mqtt_common",
    "enable_publish": true,
    "enable_control": true,
    "offline_cache": false,
    "config": {
        "publisher_ssl_enable": false,
        "publisher_ssl_version": "default",
        "version": "v2",
        "host": "192.168.9.33",
        "port": 1883
    },
    "interval": 1,
    "offlineCache": true,
    "name": "aaaa"
}

C.1.11.3 プッシュ取得

項目 内容 備考
URL /publish/<id> idはプッシュidです
Method GET

  • 戻り例`

    {
    "config": {
        "host": "111",
        "port": 222,
        "publisher_ssl_enable": false,
        "publisher_ssl_version": "default",
        "version": "v2"
    },
    "enable": true,
    "enable_control": true,
    "enable_publish": true,
    "id": 1,
    "interval": 1,
    "name": "aaaa",
    "type": "mqtt_common"
}

C.1.11.4 プッシュ変更

項目 内容 備考
URL /publish/<id> idはプッシュidです
Method PUT

  • リクエスト例`

    {
    "config": {
        "host": "111",
        "port": 222,
        "publisher_ssl_enable": false,
        "publisher_ssl_version": "default",
        "version": "v2"
    },
    "enable": true,
    "enable_control": true,
    "enable_publish": true,
    "id": 1,
    "interval": 1,
    "name": "aaaa",
    "type": "mqtt_common"
}

C.1.11.5 プッシュ削除

項目 内容 備考
URL /publish/<id> idはプッシュidです
Method DELETE

C.1.12 カスタムプッシュプラットフォーム

C.1.12.1 プッシュプラットフォームリスト取得

項目 内容 備考
URL /publish_type
Method GET

  • 戻り例`

    [
    {
        "id": 1,
        "builtin": 0,
        "rank": 100,
        "schema": "xxxx", 
        "script": ",
        "name": "通用MQTT V2"
    }
]

C.1.12.2 プッシュプラットフォーム追加

項目 内容 備考
URL /publish_type
Method POST

  • リクエスト例`

    {
    "builtin": 0,
    "rank": 100,
    "schema": "xxxx", 
    "script": ",
    "name": "通用MQTT V2"
}

C.1.12.3 プッシュプラットフォーム取得

項目 内容 備考
URL /publish_type/<id> idはプッシュプラットフォームidです
Method GET

  • 戻り例`

    {
    "id": 1,
    "builtin": 0,
    "rank": 100,
    "schema": "xxxx", 
    "script": ",
    "name": "通用MQTT V2"
}

C.1.12.4 プッシュプラットフォーム変更

項目 内容 備考
URL /publish_type/<id> idはプッシュプラットフォームidです
Method PUT

  • リクエスト例`

    {
    "id": 1,
    "builtin": 0,
    "rank": 100,
    "schema": "xxxx", 
    "script": ",
    "name": "通用MQTT V2"
}

C.1.12.5 プッシュプラットフォーム削除

項目 内容 備考
URL /publish_type/<id> idはプッシュプラットフォームidです
Method DELETE

C.1.12.6 プッシュプラットフォームテスト

項目 内容 備考
URL /publish_type/<id>/test idはプッシュidです
Method PUT

C.1.13 システム更新

C.1.13.1 更新確認

項目 内容 備考
URL /system/update
Method GET

  • 戻り例`

    {
    "id": 1,
    "builtin": 0,
    "rank": 100,
    "schema": "xxxx", 
    "script": ",
    "name": "通用MQTT V2"
}

C.1.13.2 更新確認

項目 内容 備考
URL /system/update
Method PUT

  • リクエスト例`

    {
    "id": 1,
    "builtin": 0,
    "rank": 100,
    "schema": "xxxx", 
    "script": ",
    "name": "通用MQTT V2"
}

C.1.13.3 更新ファームウェアアップロード

項目 内容 備考
URL /system/update
Method POST

C.1.14 VPN設定

C.1.14.1 VPN情報取得

項目 内容 備考
URL /vpn
Method GET

  • 戻り例`

    {
    "enable": true,
    "password": "woody",
    "type": 1,
    "username": "8ea29081b4c78e7bfa539622eb0038c4"
}

C.1.14.2 VPN情報変更

項目 内容 備考
URL /vpn
Method PUT

  • リクエスト例`

    {
    "enable": true,
    "password": "woody",
    "type": 1,
    "username": "8ea29081b4c78e7bfa539622eb0038c4"
}