アプライアンス関連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

アプライアンスの内容を書き換える

URLパラメータ

Name Comment
applianceid アプライアンスID

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時間後)

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/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

パラメータ

名前 省略 説明
RecycleProcess boolean 不可 プロセスを最利用するときtrue

GET/appliance/:applianceid/status

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

URLパラメータ

Name Comment
applianceid アプライアンスID

GET/commonserviceitem

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

POST/commonserviceitem

共通サービス契約を作成

パラメータ

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

オブジェクト構造

アクセス キー バリデーション
読取 検索 書込 更新 必須 デフォルト 範囲
ID : int  
Name : string 1~64文字
Description : string  
Settings : json   65536文字
Status : json  
ServiceClass : string  
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/health

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

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

URLパラメータ

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