アプライアンス関連API

GET/appliance

アプライアンス一覧を取得

POST/appliance

アプライアンスを作成

GET/appliance/:applianceid

該当IDのアプライアンス情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID

PUT/appliance/:applianceid

アプライアンスを更新

URLパラメータ

Name Comment
applianceid アプライアンスID

DELETE/appliance/:applianceid

該当IDのアプライアンスを削除

URLパラメータ

Name Comment
applianceid アプライアンスID

PUT/appliance/:applianceid/config

該当IDのアプライアンスの現在の設定を反映

URLパラメータ

Name Comment
applianceid アプライアンスID

GET/appliance/:applianceid/cpu/:serverindex/monitor

該当IDのアプライアンスが持つ Server のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/cpu/monitor

該当IDのアプライアンスが持つ Server のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/database/:serverindex/monitor

該当IDのアプライアンスが持つ Database のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/database/monitor

該当IDのアプライアンスが持つ Database のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/disk/:diskindex/monitor

該当IDのアプライアンスが持つディスクに関するリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号
index ディスクの順番

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/disk/monitor

該当IDのアプライアンスが持つディスクに関するリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号
index ディスクの順番

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/interface/:index

該当IDのインタフェース情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index インタフェース番号

GET/appliance/:applianceid/interface/:index/monitor

該当IDのアプライアンスが持つインタフェースに関するネットワーク流量のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index インタフェース番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

DELETE/appliance/:applianceid/interface/:index/to/switch

インタフェースとスイッチの接続を解除

URLパラメータ

Name Comment
applianceid アプライアンスID
index インタフェース番号

PUT/appliance/:applianceid/interface/:index/to/switch/:switchid

インタフェースとスイッチを接続

URLパラメータ

Name Comment
applianceid アプライアンスID
index インタフェース番号
switchid スイッチID

PUT/appliance/:applianceid/interface/:index/to/switch/shared

インタフェースから共有セグメントに接続

URLパラメータ

Name Comment
applianceid アプライアンスID
index インタフェース番号

GET/appliance/:applianceid/interface/monitor

該当IDのアプライアンスが持つインタフェースに関するネットワーク流量のリソースモニタ情報を取得

最初のインタフェースに関する情報を取得します。
他のインタフェースについては GET /appliance/:applianceid/interface/:index/monitor をご利用ください。

URLパラメータ

Name Comment
applianceid アプライアンスID

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/mobilegateway/:action

該当IDの モバイルゲートウェイ 情報を取得する

URLパラメータ

Name Comment
applianceid アプライアンス
action dnsresolver: セキュアモバイルコネクトモバイルゲートウェイに設定されているDNSサーバを取得する
sims: モバイルゲートウェイに紐付いているSIMのリストを取得する
simroutes:セキュアモバイルコネクトモバイルゲートウェイのSIM Routeを取得する
traffic_monitoring: モバイルゲートウェイの通信料監視状態を取得する
traffic_status: モバイルゲートウェイのトラフィックシェイピング状態の取得

POST/appliance/:applianceid/mobilegateway/:action

該当IDの モバイルゲートウェイにリソースを登録する

URLパラメータ

Name Comment
applianceid アプライアンス
action sims: SIMをモバイルゲートウェイに紐付ける

PUT/appliance/:applianceid/mobilegateway/:action

該当IDの モバイルゲートウェイ 設定する

URLパラメータ

Name Comment
applianceid アプライアンス
action dnsresolver: セキュアモバイルコネクトモバイルゲートウェイのDNSサーバを設定する
simroutes:セキュアモバイルコネクトモバイルゲートウェイにSIM Routeを設定する
traffic_monitoring: モバイルゲートウェイの通信料監視を設定する

DELETE/appliance/:applianceid/mobilegateway/:action

該当IDの モバイルゲートウェイ から設定を解除する

URLパラメータ

Name Comment
applianceid アプライアンス
action traffic_monitoring: モバイルゲートウェイの通信料監視を解除する

DELETE/appliance/:applianceid/mobilegateway/:action/:item

該当IDの モバイルゲートウェイ からリソースを解除する

URLパラメータ

Name Comment
applianceid アプライアンス
action sims: モバイルゲートウェイからSIMの紐付けを解除する
item SIMの契約ID

GET/appliance/:applianceid/nfs/:serverindex/monitor

該当IDのアプライアンスが持つ NFS のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/nfs/monitor

該当IDのアプライアンスが持つ NFS のリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/power

該当IDのアプライアンスの起動状態を取得

URLパラメータ

Name Comment
applianceid アプライアンスID

PUT/appliance/:applianceid/power

該当IDのアプライアンスを起動

URLパラメータ

Name Comment
applianceid アプライアンスID

DELETE/appliance/:applianceid/power

該当IDのアプライアンスを停止、または強制停止

URLパラメータ

Name Comment
applianceid アプライアンスID

パラメータ

名前 省略 説明
Force boolean 不可 強制停止するときtrue

PUT/appliance/:applianceid/reset

該当IDのアプライアンスのリセットボタンを押下

URLパラメータ

Name Comment
applianceid アプライアンスID

GET/appliance/:applianceid/server/:serverindex/disk/:diskindex/monitor

該当IDのアプライアンスが持つディスクに関するリソースモニタ情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID
index サーバの番号
index ディスクの順番

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/appliance/:applianceid/status

該当IDのアプライアンスのステータスを取得

URLパラメータ

Name Comment
applianceid アプライアンスID

GET/appliance/:applianceid/vpcrouter/sitetosite/connectiondetails

該当IDのアプライアンスのサイト間VPNについてVPN接続に必要な情報を取得

URLパラメータ

Name Comment
applianceid アプライアンスID

GET/commonserviceitem

共通サービス契約一覧を取得

POST/commonserviceitem

共通サービス契約を作成

パラメータ

名前 省略 説明
CommonServiceItem.Name string 不可 名前

オブジェクト構造

アクセス キー バリデーション
読取 検索 書込 更新 必須 デフォルト 範囲
ID : int  
Name : string 1~64文字
Description : string  
Settings : json   131072文字
Status : json  
ServiceClass : string  
Availability : EAvailability  
Provider.ID : int  
Provider.ServiceClass : string  
Icon.ID : int  

GET/commonserviceitem/:commonserviceitemid

該当IDの共通サービス契約情報を取得

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

PUT/commonserviceitem/:commonserviceitemid

共通サービス契約を更新

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

DELETE/commonserviceitem/:commonserviceitemid

該当IDの共通サービス契約を削除

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

GET/commonserviceitem/:commonserviceitemid/activity/awsdirectconnect/monitor

該当IDのGRAPHITEに保存されているACTIVITY情報を取得

このAPIはAWS接続オプションのみ有効です。クラウドDNSでは使用できません。

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/commonserviceitem/:commonserviceitemid/activity/localrouter/monitor

該当IDのGRAPHITEに保存されているACTIVITY情報を取得

このAPIはlocalrouterのみ有効です。クラウドDNSでは使用できません。

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/commonserviceitem/:commonserviceitemid/activity/responsetimesec/monitor

該当IDのGRAPHITEに保存されているACTIVITY情報を取得

このAPIはシンプル監視のみ有効です。クラウドDNSでは使用できません。

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

パラメータ

名前 省略 説明
[Start] time 取得範囲の開始時刻(省略時は終了時刻の24時間前 または 現在時刻)
[End] time 取得範囲の終了時刻(省略時は開始時刻の24時間後)

GET/commonserviceitem/:commonserviceitemid/health

該当IDの共通サービス契約に関するヘルス情報を取得

このAPIはGLSB/シンプル監視のみ有効です。クラウドDNSでは使用できません。

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID

GET/commonserviceitem/:commonserviceitemid/sim/:action

該当IDの さくらSIM 情報を取得する

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID
action status: SIMの状態を取得する
metrics: SIMのトラフィック情報を取得する

PUT/commonserviceitem/:commonserviceitemid/sim/:action

該当IDの さくらSIM 実行/設定する

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID
action activate: SIMのステータスを有効化する
deactivate: SIMのステータスを無効化する
imeilock: IMEIロックを行う
ip: SIMにIPアドレスをアサインする

DELETE/commonserviceitem/:commonserviceitemid/sim/:action

該当IDの さくらSIM 削除/解除する

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID
action imeilock: IMEIロックを解除する
ip: SIMにアサインされたIPアドレスを解除する

GET/commonserviceitem/:commonserviceitemid/sim/:action/:item

該当IDの さくらSIM 情報を取得する

URLパラメータ

Name Comment
commonserviceitemid 共通サービス契約ID
action sessionlog: SIMのセッションログを取得する
item ※ オプション LogID