アプライアンス関連API

GET /appliance - アプライアンス一覧を取得
POST /appliance - アプライアンスを作成
GET /appliance/:applianceid - 該当IDのアプライアンス情報を取得
PUT /appliance/:applianceid - アプライアンスを更新
DELETE /appliance/:applianceid - 該当IDのアプライアンスを削除
PUT /appliance/:applianceid/config - アプライアンスの内容を書き換える
GET /appliance/:applianceid/interface/monitor - 該当IDのアプライアンスのインタフェースのリソースモニタ情報を取得
GET /appliance/:applianceid/power - 該当IDのアプライアンスの起動状態を取得
PUT /appliance/:applianceid/power - 該当IDのアプライアンスを起動
DELETE /appliance/:applianceid/power - 該当IDのアプライアンスを停止、または強制停止
PUT /appliance/:applianceid/reset - 該当IDのアプライアンスのリセットボタンを押下
GET /appliance/:applianceid/status - 該当IDのアプライアンスのステータスを取得

GET/appliance

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

サンプル
- curl

curl

curl --user "Access Token":"Access Token Secret" \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/appliance

POST/appliance

アプライアンスを作成

サンプル
- リクエスト

リクエストボディ

// ロードバランサ冗長化構成なしを作成する例
{
    "Appliance":{
        "Class":"loadbalancer",
        "Name":"ロードバランサ名",
        "Description":"説明文",
        "Settings":{
            "LoadBalancer":[
                {
                    "VirtualIPAddress":"XXX.XXX.XXX.XXX",
                    "Port":80,
                    "DelayLoop":120,
                    "Servers":[{
                        "IPAddress":"XXX.XXX.XXX.XXX",
                        "Port":80,
                        "HealthCheck":{"Protocol":"ping"}
                    }]
                }
            ]
        },
        "Remark": {
            "Zone":{"ID":123},
            "Switch":{"ID":123456},
            "VRRP":{
                "VRID":1234
            },
          "Network":{
            "NetworkMaskLen":28,
            "DefaultRoute":"XXX.XXX.XXX.XXX"
          },
          "Servers":[
            {"IPAddress":"XXX.XXX.XXX.XXX"}
            //冗長化構成の時は、さらに1つ追加
          ]
    }
}

GET/appliance/:applianceid

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

サンプル
- レスポンス
- curl

レスポンスボディ

{
    "Appliance": {
        "ID":"112500119216",
        "Class":"loadbalancer",
        "Name":"LB",
        "Description":"左から右へと受け流す〜♪",
        "Settings":{
            "LoadBalancer":[
                {
                    "VirtualIPAddress":"XXX.XXX.XXX.XXX",
                    "Port":"80",
                    "DelayLoop":"10",
                    "Servers": [
                        {
                            "IPAddress":"XXX.XXX.XXX.XXX",
                            "Port":"80",
                            "HealthCheck":{
                                "Protocol":"http",
                                "Path":"/pasta_ga_tabe.ty",
                                "Status":"200"
                            },
                            "Status":"DOWN",
                            "ActiveConn":"0"
                        }
                    ]
                }
            ]
        },
        "Remark":{
            "Zone":{
                "ID":12345
            },
            "Switch":{
                "ID":"XXXXXXXXXXXX"
            },
            "VRRP":{
                "VRID":1
            },
            "Network":{
                "NetworkMaskLen":24,
                "DefaultRoute":"192.168.0.1"
            },
            "Servers":[
                {
                    "IPAddress":"192.168.0.31"
                }
            ]
        },
        "Availability":"available",
        "Instance":{
            "Status":"up"
        },
        "ServiceClass":"cloud/appliance/loadbalancer/1",
        "CreatedAt":"2013-03-18T08:36:24+09:00",
        "Switch":{
            "ID":"XXXXXXXXXXXX",
            "Name":"XXXX-XXXX",
            "Internet":null,
            "Scope":"user",
            "Availability":"available",
            "Zone":{
                "ID":"XXXXX",
                "Name":"",
                "Availability": "available",
                "Region": {
                    "ID": "XXX",
                    "Name": "Switch Name",
                    "Availability": "available"
                }
            }
        }
    },
    "is_ok": true
}

curl

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/appliance/:applianceid

URLパラメータ

Name	Comment
applianceid	アプライアンスID

PUT/appliance/:applianceid

アプライアンスを更新

サンプル
- リクエスト

リクエストボディ

// 情報を更新する例
// ※更新後にSettingsを反映するにはPUT /appliance/:applianceid/config する
{
    "Appliance":{
        "Class":"loadbalancer",
        "Name":"ロードバランサ名",
        "Description":"説明文",
        "Settings":{
            "LoadBalancer":[
                {
                    "VirtualIPAddress":"XXX.XXX.XXX.XXX",
                    "Port":80,
                    "DelayLoop":120,
                    "Servers":[{
                        "IPAddress":"XXX.XXX.XXX.XXX",
                        "Port":80,
                        "HealthCheck":{"Protocol":"ping"}
                    }]
                }
            ]
        },
        "Remark": {
            "Zone":{"ID":123},
            "Switch":{"ID":123456},
            "VRRP":{
                "VRID":1234
            },
          "Network":{
            "NetworkMaskLen":28,
            "DefaultRoute":"XXX.XXX.XXX.XXX"
          },
          "Servers":[
            {"IPAddress":"XXX.XXX.XXX.XXX"}
            //冗長化構成の時は、さらに1つ追加
          ]
    }
}

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

該当IDのアプライアンスのインタフェースのリソースモニタ情報を取得

拡張子に .png を付加して直接imgタグで表示できます。

URLパラメータ

Name	Comment
applianceid	アプライアンスID

パラメータ

名前	型	省略	説明
[Start]	time	可	取得範囲の開始時刻（省略時は終了時刻の24時間前または現在時刻）
[End]	time	可	取得範囲の終了時刻（省略時は開始時刻の24時間後）
[NoLegend]	bool	可	凡例を非表示にするときtrue

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