WebAPI
AirManage2サーバのWebAPIについて説明します。テナント管理者が実行可能なAPIの一覧となります。
info
システム管理者用APIについては本マニュアルには記載いたしません。システム管理者用APIの内容についてはスタンダードプラン及びエンタープライズプラン契約時に弊社サポートへお問い合わせください。
テナントサマリ確認API
自分が管理するテナント内のノードのサマリを確認できます。
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
group_id | グループのId。グループ画面で確認します。指定しないとテナントに所属する監視対象のノードの情報を取得します。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。内容は、ノード状況画面で表示される情報と同じです。詳しくは、ノード状況をご覧ください。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
summary | JSONオブジェクト |
total | 全ノード数 |
unmonitored | 監視対象外ノード数 |
monitored | 監視対象ノード数 |
inactive | 接続不能ノード数 |
active | 接続ノード数 |
download_queued | ダウンロード待ち |
download_running | ダウンロード中 |
download_finished | アップデート指示待ち |
download_failed | ダウンロード失敗 |
upgrade_queued | アップデート待ち |
upgrade_running | アップデート実行中 |
upgrade_failed | アップデート失敗 |
attention | アテンションあり |
- 例
cURLコマンドでのアクセス例です。
- グループIdを指定しない場合
- グループIdを指定した場合
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
ノード簡易情報確認API
自分が管理するテナント内のノードの簡易情報を確認できます。
- リクエストURL
- リクエスト
リクエストメソッドはGETです。または、リクエストデータ形式はクエリです。
クエリ | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
nodes | JSONオブジェクト配列 |
id | ノードのユニークID |
location | 場所情報(未設定の場合、null) |
ping_at | 最終接続確認時刻 |
connected | 接続状態 |
ondemand_maintenance | オンデマンド接続時におけるメンテナンスモード嬢状況 |
group_name | グループ名 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
ノード詳細情報確認API
自分が管理するテナント内のノードの詳細情報を確認できます。
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
node_id または node_name | 詳細情報を確認したいテナント内のノードのユニークIDまたはノード名。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
nodeinfo | JSONオブジェクト |
id | ノードのユニークID。 |
group_id | ノードが所属するグループのID。 |
name | AirManage上で登録されているノード名。 |
hwname | AirManage上で登録されているHW名。 |
status | ノードのステータス情報。 |
ping_at | 最終通信確認時刻。 |
location | 場所情報。 |
connected | 接続状態。 |
attention | アテンション情報。 |
uploadfile_id | ファイルアップロード機能のアップロード対象とするファイルID。 |
expired_at | 有効期限。 |
active | AirManageサービスの有効・無効状態。 |
jobs | AirManageでの待機ジョブ一覧。 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
テナント詳細確認API
自分が管理するテナント内のノード全体の詳細を確認できます。
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
group_id | グループのId。グループ画面で確認します。指定しない場合、テナントに所属する全体のノードの情報を取得します。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
nodesinfo | JSONオブジェクト配列 |
id | ノードのユニークID。 |
group_id | ノードが所属するグループのID。 |
name | AirManage上で登録されているノード名。 |
hwname | AirManage上で登録されているHW名。 |
status | ノードのステータス情報。 |
ping_at | 最終通信確認時刻。 |
location | 場所情報。 |
connected | 接続状態。 |
attention | アテンション情報。 |
uploadfile_id | ファイルアップロード機能のアップロード対象とするファイルID。 |
expired_at | 有効期限。 |
active | AirManageサービスの有効・無効状態。 |
jobs | AirManageでの待機ジョブ一覧。 |
- 例
cURLコマンドでのアクセス例です。
- グループIdを指定しない場合
- グループIdを指定した場合
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
ファイルアップロードAPI
自分が管理するテナント内のノードに配信するためのファイルをアップロードできます。
info
本APIではノードへのファイル配信自体は行われません。別途、ノードへのファイル配信はファイルアップロードジョブAPIを実行する必要があります。
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はマルチパートフォームです。
パラメータ | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
group_id | ファイルをアップロード対象とするグループのId。グループ画面で確認します。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
uploadfile | アップロード対象のファイル。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
file_id | アップロード時に割り振られるファイルID。 |
filename | アップロード時のファイル名です。 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
ファイルアップロードジョブAPI
自分が管理するテナント内のノードへのファイル配信ジョブの登録を行います
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
group_id | ファイルをアップロード対象とするグループのId。グループ画面で確認します。※ファイルをAirManageにアップロード時のグループIDと同一である必要があります。 |
node_id または node_name | ファイル配信対象のテナント内のノードのユニークIDまたはノード名。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
file_id | ファイルアップロードAPIのレスポンスのID。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
ファイルアップロードジョブ取消API
自分が管理するテナント内のノードへのファイル配信ジョブの取り消しを行います。
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
node_id または node_name | ファイル配信対象のテナント内のノードのユニークIDまたはノード名。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
ノード全ジョブ取消API
自分が管理するテナント内のノードが実施処理予定のジョブの取り消しを行います。
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
node_id または node_name | 全ジョブを取り消す対象のテナント内のノードのユニークIDまたはノード名。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
アテンション解除API
自分が管理するテナント内のノードのアテンションを解除するジョブの登録を行います
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
node_id または node_name | アテンションを解除する対象のテナント内のノードのユニークIDまたはノード名。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。
テナントアテンション解除一括API
自分が管理するテナント内の全てノード、または対象グループのノードに対してアテンションを解除するジョブの登録を行います
- リクエストURL
- リクエスト
リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。
JSONキー | 内容 |
---|---|
tenant_code | テナント記号。テナント一覧画面で確認します。 |
group_id | アテンション解除の対象とするグループのId。グループ画面で確認します。指定しないとテナントに所属する全てのノードが対象となります。 |
token | アクセストークン。テナント管理者のユーザの設定画面にて確認します。 |
- レスポンス
レスポンスはJSON形式です。以下は正常時のレスポンスのJSONキーとなります。
JSONキー | 内容 |
---|---|
result | 実行結果 |
- 例
cURLコマンドでのアクセス例です。
上記のコマンドを実行した場合の出力例(jqコマンドで整形)です。