Download OpenAPI specification:
Copyright(C) FURUKAWA ELECTRIC CO., LTD.
このAPIはFITELnet機器の管理および操作を行うためのものです。
対応機種・ファームウェアバージョンは以下の通りです。
以下の機能を提供します。
REST通信
認証
API
接続元アドレスの制限
アクセストークンに関する情報を取得する。
| access_token required | string Example: 1234567890abcdef1234567890abcdef 有効期限を取得するアクセストークン |
{- "access_token": "1234567890abcdef1234567890abcdef",
- "token_type": "Bearer",
- "expires_in": 3600,
- "permit": "read"
}CLIの運用コマンドを実行する。
| cmd required | string 実行するCLIコマンド |
{- "cmd": "show version"
}{- "error": "An invalid value was specified."
}CLIコマンドの複数実行を行います。
コマンドを受け付けた後は実行開始前にCLIコマンドID(clis_id)を返信します。
1 APIで入力可能なコマンド最大数は10個です。
コマンド実行結果の情報についてはGET /clisでclis_idを指定することで確認することができます。
コマンド実行結果の情報は最大30個保存されます。
コマンド実行結果の情報は全てのコマンド実行完了から1時間保持されます。
on_fail (失敗時の動作指定)
on_failを指定しない場合、コマンド実行失敗時は次のコマンドを実行します。
actionに"exit"を指定した場合、コマンド実行失敗時はその場で終了します。
required | Array of objects [ 1 .. 10 ] items 実行するCLIコマンドのリスト（最大10個） |
| total required | integer コマンド数（list配列の要素数と一致） |
{- "list": [
- {
- "cmd": "show version",
- "on_fail": {
- "action": "exit"
}
}, - {
- "cmd": "extract-firmware /drive/F220.FRM force moff",
- "on_fail": {
- "action": "continue"
}
}
], - "total": 2
}{- "clis_id": 1,
- "expires_in": 3600
}指定したCLIコマンドIDの複数CLIコマンドの実行結果を取得します。
コマンド実行中の場合はコマンドの状態のみを返却します。
| clis_id required | integer Example: 1 取得するCLIコマンドID |
{- "clis_id": 1,
- "list": [
- {
- "cmd": "show version",
- "result": "success",
- "contents": "コマンド実行結果"
}, - {
- "cmd": "extract-firmware /drive/F220.FRM force moff",
- "result": "success",
- "contents": "コマンド実行結果"
}
], - "total": 2
}指定したCLIコマンドIDの複数CLIコマンドの実行結果を削除します。
コマンド実行中の場合は削除できません（コマンドの中止を行いません）。
| clis_id required | integer Example: 1 削除するCLIコマンドID |
{- "error": "Insufficient permission to delete."
}