アプライアンス関連API

GET

/appliance

-

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

/appliance

-

アプライアンスを作成
GET

/appliance/:applianceid

-

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

/appliance/:applianceid

-

アプライアンスを更新
DELETE

/appliance/:applianceid

-

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

/appliance/:applianceid/config

-

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

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

-

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

/appliance/:applianceid/cpu/monitor

-

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

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

-

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

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

-

アプライアンス(Database)固有のリソースモニタ情報を登録する。。
GET

/appliance/:applianceid/database/monitor

-

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

/appliance/:applianceid/database/parameter

-

該当IDのアプライアンスが持つデータベース項目設定情報を取得
PUT

/appliance/:applianceid/database/parameter

-

該当IDのアプライアンスが持つデータベース項目設定情報を設定
DELETE

/appliance/:applianceid/database/parameter

-

該当IDのアプライアンスが持つデータベース項目設定情報をリセット
GET

/appliance/:applianceid/database/plugin

-

該当IDのアプライアンスが持つデータベースプラグイン設定情報を取得
PUT

/appliance/:applianceid/database/plugin

-

該当IDのアプライアンスが持つデータベースプラグイン設定情報を設定
GET

/appliance/:applianceid/database/replica-slaves

-

該当IDのアプライアンスが持つ Database のSlaves の Status 情報を取得
GET

/appliance/:applianceid/database/slaves

-

該当IDのアプライアンスが持つ Database のSlaves情報を取得
GET

/appliance/:applianceid/database/slaves/status

-

該当IDのアプライアンスが持つ Database のSlaves の Status 情報を取得
GET

/appliance/:applianceid/database/syslog

-

該当IDのアプライアンスが持つデータベース Syslog 設定情報を取得
PUT

/appliance/:applianceid/database/syslog

-

該当IDのアプライアンスが持つデータベース Syslog 設定情報を設定
GET

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

-

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

/appliance/:applianceid/disk/monitor

-

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

/appliance/:applianceid/interface/:index

-

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

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

-

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

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

-

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

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

-

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

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

-

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

/appliance/:applianceid/interface/monitor

-

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

/appliance/:applianceid/mobilegateway/:action

-

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

/appliance/:applianceid/mobilegateway/:action

-

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

/appliance/:applianceid/mobilegateway/:action

-

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

/appliance/:applianceid/mobilegateway/:action

-

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

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

-

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

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

-

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

/appliance/:applianceid/nfs/monitor

-

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

/appliance/:applianceid/plan

-

該当IDのアプライアンスプラン変更(世代変更・アップグレード)
GET

/appliance/:applianceid/power

-

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

/appliance/:applianceid/power

-

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

/appliance/:applianceid/power

-

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

/appliance/:applianceid/reset

-

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

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

-

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

/appliance/:applianceid/server/:serverindex/plan

-

該当IDのアプライアンスプラン変更(世代変更・アップグレード)
GET

/appliance/:applianceid/status

-

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

/appliance/:applianceid/vpcrouter/ping/:target_ipaddr

-

該当IDのアプライアンスからpingを送出させる
PUT

/appliance/:applianceid/vpcrouter/restartvpn

-

該当IDのアプライアンスのvpnをrestartさせる
GET

/appliance/:applianceid/vpcrouter/sitetosite/connectiondetails

-

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

/commonserviceitem

-

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

/commonserviceitem

-

共通サービス契約を作成
GET

/commonserviceitem/:commonserviceitemid

-

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

/commonserviceitem/:commonserviceitemid

-

共通サービス契約を更新
DELETE

/commonserviceitem/:commonserviceitemid

-

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

/commonserviceitem/:commonserviceitemid/activity/awsdirectconnect/monitor

-

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

/commonserviceitem/:commonserviceitemid/activity/localrouter/monitor

-

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

/commonserviceitem/:commonserviceitemid/activity/proxylb/monitor

-

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

/commonserviceitem/:commonserviceitemid/activity/responsetimesec/monitor

-

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

/commonserviceitem/:commonserviceitemid/certificateauthority

-

該当IDの certificateauthority 設定情報を取得する
GET

/commonserviceitem/:commonserviceitemid/certificateauthority/:action

-

該当IDの certificateauthority 設定情報を取得する
POST

/commonserviceitem/:commonserviceitemid/certificateauthority/:action

-

該当IDの certificateauthority の servers, clients を登録する
PUT

/commonserviceitem/:commonserviceitemid/certificateauthority/:action

-

該当IDの certificateauthority 実行/設定する
DELETE

/commonserviceitem/:commonserviceitemid/certificateauthority/:action

-

該当IDの certificateauthority 削除/解除する
GET

/commonserviceitem/:commonserviceitemid/certificateauthority/:action/:item

-

該当IDの certificateauthority 設定情報を取得する
PUT

/commonserviceitem/:commonserviceitemid/certificateauthority/:action/:item

-

該当IDの certificateauthority 実行/設定する
PUT

/commonserviceitem/:commonserviceitemid/certificateauthority/:action/:item/:item_action

-

該当IDの certificateauthority 実行/設定する
GET

/commonserviceitem/:commonserviceitemid/containerregistry/:action

-

該当IDのさくら Container Registry 設定情報を取得する
POST

/commonserviceitem/:commonserviceitemid/containerregistry/:action

-

該当IDのさくら Container Registry 実行/設定する
PUT

/commonserviceitem/:commonserviceitemid/containerregistry/:action

-

該当IDのさくら Container Registry 実行/設定する
GET

/commonserviceitem/:commonserviceitemid/containerregistry/:action/:item

-

該当IDのさくら Container Registry 設定情報を取得する
PUT

/commonserviceitem/:commonserviceitemid/containerregistry/:action/:item

-

該当IDのさくら Container Registry 実行/設定する
DELETE

/commonserviceitem/:commonserviceitemid/containerregistry/:action/:item

-

該当IDのさくら Container Registry 削除/解除する
GET

/commonserviceitem/:commonserviceitemid/esme/:action

-

該当IDの esme 設定情報を取得する
PUT

/commonserviceitem/:commonserviceitemid/esme/:action

-

該当IDの esme 実行/設定する
DELETE

/commonserviceitem/:commonserviceitemid/esme/:action

-

該当IDの esme 削除/解除する
GET

/commonserviceitem/:commonserviceitemid/esme/:action/:item

-

該当IDの esme 設定情報を取得する
PUT

/commonserviceitem/:commonserviceitemid/esme/:action/:item

-

該当IDの esme 実行/設定する
GET

/commonserviceitem/:commonserviceitemid/health

-

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

/commonserviceitem/:commonserviceitemid/plan

-

該当IDの共通サービス契約のプランを変更
GET

/commonserviceitem/:commonserviceitemid/proxylb/:action

-

該当IDのさくらproxylb 設定情報を取得する
PUT

/commonserviceitem/:commonserviceitemid/proxylb/:action

-

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

/commonserviceitem/:commonserviceitemid/proxylb/:action

-

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

/commonserviceitem/:commonserviceitemid/sim/:action

-

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

/commonserviceitem/:commonserviceitemid/sim/:action

-

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

/commonserviceitem/:commonserviceitemid/sim/:action

-

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

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

-

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

/commonserviceitem/:commonserviceitemid/sms/:action

-

該当IDのフリーフォーマットSMS送信実行/設定する
PUT

/commonserviceitem/:commonserviceitemid/sms/:action

-

該当IDのフリーフォーマットSMS送信実行/設定する
DELETE

/commonserviceitem/:commonserviceitemid/sms/:action

-

該当IDのフリーフォーマットSMS送信削除/解除する

GET/appliance

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

サンプル
- curl(Linux)
- curl(Windows)

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

curl -k --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": {
      "Switch":{"ID":123456},
      "VRRP":{
        "VRID":1234
      },
      "Network":{
        "NetworkMaskLen":28,
        "DefaultRoute":"XXX.XXX.XXX.XXX"
      },
      "Servers":[
        {"IPAddress":"XXX.XXX.XXX.XXX"}
        //冗長化構成の時は、さらに1つ追加
      ]
    }
  }
}

// VPCルータスタンダードプランを作成する例
// Plan.ID=1がスタンダードプランです
{
  "Appliance": {
    "Class": "vpcrouter",
    "Name": "VPCルータスタンダードプラン",
    "Description": "説明",
    "Tags": ["aaa", "bbb"],
    "Icon": {},
    "Plan": {
      "ID": 1
    },
    "Remark": {
      "Servers": [
        {}
      ],
      "Switch": {
        "Scope": "shared"
      }
    }
  }
}

// VPCルータプレミアムプランを作成する例
// Plan.ID=2がプレミアムプランです
// 2つの物理IPアドレスと1つの仮想IPアドレス、およびVRIDの指定が必須です
{
  "Appliance": {
    "Class": "vpcrouter",
    "Name": "VPCルータプレミアムプラン",
    "Description": "説明",
    "Tags": ["aaa", "bbb"],
    "Icon": {},
    "Plan": {
      "ID": 2
    },
    "Remark": {
      "Servers": [
        {
          "IPAddress": "192.0.2.2"
        },
        {
          "IPAddress": "192.0.2.3"
        }
      ],
      "Switch": {
        "ID": "112700000000"
      }
    },
    "Settings": {
      "Router": {
        "Interfaces": [
          {
            "IPAddress": [
              "192.0.2.2",
              "192.0.2.3"
            ],
            "VirtualIPAddress": "192.0.2.1"
          }
        ],
        "VRID": 1
      }
    }
  }
}

// セキュアモバイルコネクト モバイルゲートウェイを作成する例
{
  "Appliance": {
    "Name": "おれのもばげ",
    "Class": "mobilegateway",
    "Plan": {
      "ID": 2
    },
    "Remark": {
      "Servers": [
        {}
      ],
      "Switch": {
        "Scope": "shared"
      }
    }
  }
}

GET/appliance/:applianceid

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

サンプル

{
  "Appliance": {
    "ID":"999999999999",
    "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 --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/appliance/:applianceid

curl -k --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

アプライアンスを更新

サンプル
- リクエストボディ

// ロードバランサの情報を更新する例
{
  "Appliance": {
    "Name": "ロードバランサ名",
    "Description": "説明文",
    "Tags": [
      "mytags"
    ],
    "Icon": {
      "ID": "xxxxxxxxxxxx"
    }
  }
}

// ロードバランサの設定を更新する例
// ※更新後にSettingsを反映するにはPUT /appliance/:applianceid/config する
{
  "Appliance": {
    "Settings": {
      "LoadBalancer": [
        {
          "VirtualIPAddress": "xx.xx.xx.xx",
          "Port": "80",
          "DelayLoop": "15",
          "Servers": [
            {
              "IPAddress": "xx.xx.xx.xx",
              "Port": "80",
              "HealthCheck": {
                "Protocol": "http",
                "Path": "/",
                "Status": "200"
              },
              "Enabled": "True"
            },
            {
              "IPAddress": "xx.xx.xx.xx",
              "Port": "80",
              "HealthCheck": {
                "Protocol": "ping"
              },
              "Enabled": "True"
            },
            {
              "IPAddress": "xx.xx.xx.xx",
              "Port": "80",
              "HealthCheck": {
                "Protocol": "tcp"
              },
              "Enabled": "False"
            },
            {
              "IPAddress": "xx.xx.xx.xx",
              "Port": "80",
              "HealthCheck": {
                "Protocol": "https",
                "Path": "/index.html",
                "Status": "200"
              },
              "Enabled": "False"
            }
          ]
        }
      ]
    }
  }
}


// VPCルータの情報を更新する例
{
  "Appliance": {
    "Name": "VPCルータほげほげ",
    "Description": "説明",
    "Tags": [
      "aaa",
      "bbb"
    ],
    "Icon": {}
  }
}


// VPCルータスタンダードプランの設定を変更する例
// ※更新後にSettingsを反映するにはPUT /appliance/:applianceid/config する
{
  "Appliance": {
    "Settings": {
      "Router": {
        "Interfaces": [
          null,
          {
            "IPAddress": [
              "192.168.0.1"
            ],
            "NetworkMaskLen": 24
          },
          {
            "IPAddress": [
              "192.168.1.1"
            ],
            "NetworkMaskLen": 24
          }
        ],
        "PortForwarding": {
          "Config": [
            {
              "Protocol": "tcp",
              "GlobalPort": "80",
              "PrivateAddress": "192.168.0.10",
              "PrivatePort": "80"
            },
            {
              "Protocol": "udp",
              "GlobalPort": "53",
              "PrivateAddress": "192.168.0.11",
              "PrivatePort": "53"
            }
          ],
          "Enabled": "True"
        },
        "Firewall": {
          "Config": [
            {
              "Receive": [
                {
                  "Protocol": "tcp",
                  "SourceNetwork": "203.0.113.1",
                  "SourcePort": "32768-61000",
                  "DestinationNetwork": "192.168.0.10",
                  "DestinationPort": "22",
                  "Action": "allow"
                },
                {
                  "Protocol": "udp",
                  "SourceNetwork": "198.51.100.0/24",
                  "SourcePort": null,
                  "DestinationNetwork": null,
                  "DestinationPort": "53",
                  "Action": "allow"
                },
                {
                  "Protocol": "ip",
                  "SourceNetwork": null,
                  "DestinationNetwork": null,
                  "Action": "deny"
                }
              ],
              "Send": [
                {
                  "Protocol": "icmp",
                  "SourceNetwork": "192.168.0.0/24",
                  "DestinationNetwork": "192.0.2.0/24",
                  "Action": "deny"
                },
                {
                  "Protocol": "ip",
                  "SourceNetwork": null,
                  "DestinationNetwork": "198.51.100.111",
                  "Action": "deny"
                }
              ]
            }
          ],
          "Enabled": "True"
        },
        "DHCPServer": {
          "Config": [
            {
              "Interface": "eth1",
              "RangeStop": "192.168.0.249",
              "RangeStart": "192.168.0.240"
            },
            {
              "Interface": "eth2",
              "RangeStop": "192.168.1.249",
              "RangeStart": "192.168.1.240"
            }
          ],
          "Enabled": "True"
        },
        "DHCPStaticMapping": {
          "Config": [
            {
              "MACAddress": "aa:bb:cc:dd:ee:ff",
              "IPAddress": "192.168.0.250"
            },
            {
              "MACAddress": "aa:bb:cc:dd:ee:00",
              "IPAddress": "192.168.1.251"
            }
          ],
          "Enabled": "True"
        },
        "PPTPServer": {
          "Enabled": "True",
          "Config": {
            "RangeStart": "192.168.0.230",
            "RangeStop": "192.168.0.239"
          }
        },
        "L2TPIPsecServer": {
          "Enabled": "True",
          "Config": {
            "RangeStart": "192.168.0.220",
            "RangeStop": "192.168.0.229",
            "PreSharedSecret": "abcd1234"
          }
        },
        "RemoteAccessUsers": {
          "Config": [
            {
              "UserName": "micho1",
              "Password": "asdf1234"
            },
            {
              "UserName": "micho2",
              "Password": "asdf1234"
            }
          ],
          "Enabled": "True"
        },
        "SiteToSiteIPsecVPN": {
          "Config": [
            {
              "Peer": "198.51.100.10",
              "PreSharedSecret": "abcd1234",
              "RemoteID": "198.51.100.10",
              "Routes": [
                "10.0.0.0/24",
                "10.0.1.0/24"
              ],
              "LocalPrefix": [
                "192.168.0.0/24",
                "192.168.1.0/24"
              ]
            },
            {
              "Peer": "203.0.113.20",
              "PreSharedSecret": "abcd1234",
              "RemoteID": "203.0.113.20",
              "Routes": [
                "10.0.2.0/24",
                "10.0.3.0/24"
              ],
              "LocalPrefix": [
                "192.168.0.0/24",
                "192.168.1.0/24"
              ]
            }
          ],
          "Enabled": "True"
        }
      }
    }
  }
}


// VPCルータプレミアムプランの設定を変更する例
// ※更新後にSettingsを反映するにはPUT /appliance/:applianceid/config する

{
  "Appliance": {
    "Settings": {
      "Router": {
        "Interfaces": [
          {
            "IPAddress": [
              "192.0.2.2",
              "192.0.2.3"
            ],
            "VirtualIPAddress": "192.0.2.1",
            "IPAliases": [
              "192.0.2.4",
              "192.0.2.5"
            ]
          },
          {
            "IPAddress": [
              "192.168.0.2",
              "192.168.0.3"
            ],
            "VirtualIPAddress": "192.168.0.1",
            "NetworkMaskLen": 24
          },
          {
            "IPAddress": [
              "192.168.1.2",
              "192.168.1.3"
            ],
            "VirtualIPAddress": "192.168.1.1",
            "NetworkMaskLen": 24
          }
        ],
        "VRID": 1,
        "StaticNAT": {
          "Config": [
            {
              "GlobalAddress": "192.0.2.4",
              "PrivateAddress": "192.168.1.10"
            },
            {
              "GlobalAddress": "192.0.2.5",
              "PrivateAddress": "192.168.1.11"
            }
          ],
          "Enabled": "True"
        },
        "PortForwarding": {
          "Config": [
            {
              "Protocol": "tcp",
              "GlobalPort": "80",
              "PrivateAddress": "192.168.0.10",
              "PrivatePort": "80"
            },
            {
              "Protocol": "udp",
              "GlobalPort": "53",
              "PrivateAddress": "192.168.0.11",
              "PrivatePort": "53"
            }
          ],
          "Enabled": "True"
        },
        "Firewall": {
          "Config": [
            {
              "Receive": [
                {
                  "Protocol": "tcp",
                  "SourceNetwork": "203.0.113.1",
                  "SourcePort": "32768-61000",
                  "DestinationNetwork": "192.168.0.10",
                  "DestinationPort": "22",
                  "Action": "allow"
                },
                {
                  "Protocol": "udp",
                  "SourceNetwork": "198.51.100.0/24",
                  "SourcePort": null,
                  "DestinationNetwork": null,
                  "DestinationPort": "53",
                  "Action": "allow"
                },
                {
                  "Protocol": "ip",
                  "SourceNetwork": null,
                  "DestinationNetwork": null,
                  "Action": "deny"
                }
              ],
              "Send": [
                {
                  "Protocol": "icmp",
                  "SourceNetwork": "192.168.0.0/24",
                  "DestinationNetwork": "198.51.100.0/24",
                  "Action": "deny"
                },
                {
                  "Protocol": "ip",
                  "SourceNetwork": null,
                  "DestinationNetwork": "198.51.100.111",
                  "Action": "deny"
                }
              ]
            }
          ],
          "Enabled": "True"
        },
        "DHCPServer": {
          "Config": [
            {
              "Interface": "eth1",
              "RangeStop": "192.168.0.249",
              "RangeStart": "192.168.0.240"
            },
            {
              "Interface": "eth2",
              "RangeStop": "192.168.1.249",
              "RangeStart": "192.168.1.240"
            }
          ],
          "Enabled": "True"
        },
        "DHCPStaticMapping": {
          "Config": [
            {
              "MACAddress": "aa:bb:cc:dd:ee:ff",
              "IPAddress": "192.168.0.250"
            },
            {
              "MACAddress": "aa:bb:cc:dd:ee:00",
              "IPAddress": "192.168.1.251"
            }
          ],
          "Enabled": "True"
        },
        "PPTPServer": {
          "Enabled": "True",
          "Config": {
            "RangeStart": "192.168.0.230",
            "RangeStop": "192.168.0.239"
          }
        },
        "L2TPIPsecServer": {
          "Enabled": "True",
          "Config": {
            "RangeStart": "192.168.0.220",
            "RangeStop": "192.168.0.229",
            "PreSharedSecret": "abcd1234"
          }
        },
        "RemoteAccessUsers": {
          "Config": [
            {
              "UserName": "micho1",
              "Password": "asdf1234"
            },
            {
              "UserName": "micho2",
              "Password": "asdf1234"
            }
          ],
          "Enabled": "True"
        },
        "SiteToSiteIPsecVPN": {
          "Config": [
            {
              "Peer": "198.51.100.10",
              "PreSharedSecret": "abcd1234",
              "RemoteID": "198.51.100.10",
              "Routes": [
                "10.0.0.0/24",
                "10.0.1.0/24"
              ],
              "LocalPrefix": [
                "192.168.0.0/24",
                "192.168.1.0/24"
              ]
            },
            {
              "Peer": "203.0.113.20",
              "PreSharedSecret": "abcd1234",
              "RemoteID": "203.0.113.20",
              "Routes": [
                "10.0.2.0/24",
                "10.0.3.0/24"
              ],
              "LocalPrefix": [
                "192.168.0.0/24",
                "192.168.1.0/24"
              ]
            }
          ],
          "Enabled": "True"
        }
      }
    }
  }
}

// セキュアモバイルコネクトモバイルゲートウェイの設定を変更する例
// ※更新後にSettingsを反映するにはPUT /appliance/:applianceid/config する
{
  "Appliance": {
    "Settings": {
      "MobileGateway": {
        "Interfaces": [
          null,
          {
            "IPAddress": [
              "192.168.0.1"
            ],
            "NetworkMaskLen": 24
          }
        ],
        "InternetConnection": {
          "Enabled": "True"
        },
        "StaticRoutes": [
          {
            "Prefix": "172.16.1.0/24",
            "NextHop": "192.168.0.254"
          },
          {
            "Prefix": "172.16.2.0/24",
            "NextHop": "192.168.0.254"
          }
        ]
      }
    }
  }
}

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

PUT/appliance/:applianceid/database/:serverindex/monitor

アプライアンス(Database)固有のリソースモニタ情報を登録する。。

GET/appliance/:applianceid/database/monitor

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

URLパラメータ

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

パラメータ

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

GET/appliance/:applianceid/database/parameter

該当IDのアプライアンスが持つデータベース項目設定情報を取得

URLパラメータ

Name	Comment
applianceid	アプライアンスID

PUT/appliance/:applianceid/database/parameter

該当IDのアプライアンスが持つデータベース項目設定情報を設定

URLパラメータ

Name	Comment
applianceid	アプライアンスID

DELETE/appliance/:applianceid/database/parameter

該当IDのアプライアンスが持つデータベース項目設定情報をリセット

URLパラメータ

Name	Comment
applianceid	アプライアンスID

GET/appliance/:applianceid/database/plugin

該当IDのアプライアンスが持つデータベースプラグイン設定情報を取得

URLパラメータ

Name	Comment
applianceid	アプライアンスID

PUT/appliance/:applianceid/database/plugin

該当IDのアプライアンスが持つデータベースプラグイン設定情報を設定

URLパラメータ

Name	Comment
applianceid	アプライアンスID

GET/appliance/:applianceid/database/replica-slaves

該当IDのアプライアンスが持つ Database のSlaves の Status 情報を取得

URLパラメータ

Name	Comment
applianceid	アプライアンスID

GET/appliance/:applianceid/database/slaves

該当IDのアプライアンスが持つ Database のSlaves情報を取得

URLパラメータ

Name	Comment
applianceid	アプライアンスID

GET/appliance/:applianceid/database/slaves/status

該当IDのアプライアンスが持つ Database のSlaves の Status 情報を取得

URLパラメータ

Name	Comment
applianceid	アプライアンスID

GET/appliance/:applianceid/database/syslog

該当IDのアプライアンスが持つデータベース Syslog 設定情報を取得

URLパラメータ

Name	Comment
applianceid	アプライアンスID

PUT/appliance/:applianceid/database/syslog

該当IDのアプライアンスが持つデータベース Syslog 設定情報を設定

URLパラメータ

Name	Comment
applianceid	アプライアンスID

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のモバイルゲートウェイにリソースを登録する

サンプル
- リクエストボディ

// SIMをモバイルゲートウェイに紐付ける例
// POST /appliance/:applianceid/mobilegateway/sims
{
  "sim": {
    "resource_id": "xxxxxxxxxxxx"
  }
}

URLパラメータ

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

PUT/appliance/:applianceid/mobilegateway/:action

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

サンプル
- リクエストボディ

// セキュアモバイルコネクトモバイルゲートウェイのDNSサーバを設定する例
// PUT /appliance/:applianceid/mobilegateway/dnsresolver
{
  "sim_group": {
    "dns_1": "8.8.8.8",
    "dns_2": "8.8.4.4"
  }
}

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

PUT/appliance/:applianceid/plan

該当IDのアプライアンスプラン変更(世代変更・アップグレード)

URLパラメータ

Name	Comment
applianceid	アプライアンスID
serverindex	接続されているサーバの順番

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

パラメータ

名前	型	省略	説明
Graceful	boolean	不可	通常停止後に再起起動するとき(ACPI有効な場合に、起動ホストを変更)true

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

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

URLパラメータ

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

パラメータ

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

PUT/appliance/:applianceid/server/:serverindex/plan

該当IDのアプライアンスプラン変更(世代変更・アップグレード)

URLパラメータ

Name	Comment
applianceid	アプライアンスID
serverindex	接続されているサーバの順番

GET/appliance/:applianceid/status

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

サンプル
- レスポンスボディ

// ロードバランサの場合
{
  "LoadBalancer": [
    {
      "VirtualIPAddress": "192.0.2.1",
      "Port": "80",
      "Servers": [
        {
          "ActiveConn": "10",
          "IPAddress": "192.0.2.2",
          "Status": "UP",
          "Port": "80"
        },
        {
          "ActiveConn": "0",
          "IPAddress": "192.0.2.3",
          "Status": "DOWN",
          "Port": "80"
        }
      ]
    },
    {
      "VirtualIPAddress": "192.0.2.4",
      "Port": "80",
      "Servers": [
        {
          "ActiveConn": "20",
          "IPAddress": "192.0.2.5",
          "Status": "UP",
          "Port": "80"
        },
        {
          "ActiveConn": "0",
          "IPAddress": "192.0.2.6",
          "Status": "DOWN",
          "Port": "80"
        }
      ]
    }
  ]
}

// VPCルータの場合
{
  "Router": {
    "DHCPServerLeases": [
      {
        "IPAddress": "192.168.1.210",
        "MACAddress": "xx:xx:xx:xx:xx:xx"
      },
      {
        "IPAddress": "192.168.1.211",
        "MACAddress": "xx:xx:xx:xx:xx:xx"
      }
    ],
    "L2TPIPsecServerSessions": [
      {
        "User": "micho",
        "IPAddress": "192.168.2.200",
        "TimeSec": "300"
      },
      {
        "User": "micho2",
        "IPAddress": "192.168.2.201",
        "TimeSec": "6000"
      }
    ],
    "PPTPServerSessions": [
      {
        "User": "micho3",
        "IPAddress": "192.168.2.202",
        "TimeSec": "500"
      },
      {
        "User": "micho4",
        "IPAddress": "192.168.2.203",
        "TimeSec": "7000"
      }
    ],
    "SiteToSiteIPsecVPNPeers": [
      {
        "Status": "DOWN",
        "Peer": "1.1.1.1"
      },
      {
        "Status": "UP",
        "Peer": "1.1.1.2"
      }
    ]
  }
}

URLパラメータ

Name	Comment
applianceid	アプライアンスID

POST/appliance/:applianceid/vpcrouter/ping/:target_ipaddr

該当IDのアプライアンスからpingを送出させる

パラメータ

名前	型	省略	説明
$web	Web_REST	不可

PUT/appliance/:applianceid/vpcrouter/restartvpn

該当IDのアプライアンスのvpnをrestartさせる

URLパラメータ

Name	Comment
applianceid	アプライアンスID

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

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

サンプル
- レスポンスボディ

{
  "ID": "XXXXXXXXXXXX",
  "Name": "VPCルータスタンダートプラン",
  "Details": {
    "Config": [
      {
        "VPCRouter": {
          "ID": "xx.xx.xx.xx",
          "InsideNetworks": [
            "xx.xx.xx.xx/xx"
          ],
          "OutsideIPAddress": "xx.xx.xx.xx"
        },
        "Index": 1,
        "ESP": {
          "AuthenticationProtocol": "sha1",
          "Lifetime": "28800",
          "PerfectForwardSecrecy": "enabled",
          "EncryptionProtocol": "aes128",
          "DHGroup": "modp1024",
          "Mode": "tunnel"
        },
        "IKE": {
          "AuthenticationProtocol": "sha1",
          "Lifetime": "1800",
          "PerfectForwardSecrecy": "enabled",
          "PreSharedSecret": "mytestpsk123",
          "EncryptionProtocol": "aes128",
          "Mode": "main"
        },
        "Peer": {
          "ID": "xx.xx.xx.xx",
          "InsideNetworks": [
            "xx.xx.xx.xx/xx",
          ],
          "OutsideIPAddress": "xx.xx.xx.xx"
        }
      }
    ]
  },
  "is_ok": true,
  "Success": true
}

URLパラメータ

Name	Comment
applianceid	アプライアンスID

GET/commonserviceitem

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

POST/commonserviceitem

共通サービス契約を作成

サンプル
- リクエストボディ

// GSLBの場合
// ===========
{
  "CommonServiceItem": {
    "Name": "(任意の名前)",
    "Description": "説明",
    "Settings": {
      "GSLB": {
        "DelayLoop": "10",
        "HealthCheck": {
          "Protocol": "ping"
        },
        "Servers": []
      }
    },
    "Provider": {
      "Class": "gslb"
    },
    "Tags": [],
    "Icon": {}
  }
}
// #### 補足事項
// - CommonServiceItem.Settings.GSLB.DelayLoopには、監視間隔(秒)を指定します。
//
// - 監視方法としてHTTP,HTTPSを使用する場合は、以下のように指定します。
//
// "GSLB": {
//   "DelayLoop": "10",
//   "HealthCheck": {
//     "Protocol": "http",
//     "Path": "/index.html",
//     "Status": "200"
//   },
//   "Servers": []
// }
//
// - 監視方法としてTCPを使用する場合は、以下のように指定します。
//
// "GSLB": {
//   "DelayLoop": "10",
//   "HealthCheck": {
//     "Protocol": "tcp",
//     "Port": "80"
//   },
//   "Servers": []
// }

// DNSの場合
// ==========
{
  "CommonServiceItem": {
    "Name": "(任意の名前)",
    "Status": {
      "Zone": "example.jp"
    },
    "Settings": {
      "DNS": {
        "ResourceRecordSets": []
      }
    },
    "Provider": {
      "Class": "dns"
    },
    "Tags": [],
    "Icon": {},
    "Description": "(説明)"
  }
}

// ### 補足事項
// - 登録するゾーン名を CommonServiceItem.Status.Zone に記入してください。

// シンプル監視の場合
// ===========
{
  "CommonServiceItem": {
    "Name": "192.0.2.100",
    "Description": "バリバリ監視したくなるような説明文",
    "Status": {
      "Target": "192.0.2.100"
    },
    "Settings": {
      "SimpleMonitor": {
        "DelayLoop": "60",
        "HealthCheck": {
          "Protocol": "http",
          "Path": "/",
          "Status": "200"
        },
        "NotifyEmail": {
          "Enabled": "True"
        },
        "NotifySlack": {
          "Enabled": "True",
          "IncomingWebhooksURL": "https://hooks.slack.com/services/xxx/xxx/xxx"
        },
        "Enabled": "True"
      }
    },
    "Provider": {
      "Class": "simplemon"
    },
    "Tags": [],
    "Icon": {}
  }
}
// #### 補足事項
// - 監視対象ホストをStatus.Targetに記載してください。FQDN指定も可能です。
//
// - リソース作成後の監視対象ホストの変更はできません。
//
// - DelayLoopは60秒単位で指定する必要があります。
//
// - 監視方法としてTCPを使用する場合は、以下のように指定します。
//   "HealthCheck": {
//       "Protocol": "tcp",
//       "Port": "25"
//   }
//
// - 監視方法としてpingを使用する場合は、以下のように指定します。
//   "HealthCheck": {
//       "Protocol": "ping"
//   }
//
// - 監視方法としてhttpsを使用する場合のパラメータは上記と同じです。

// セキュアモバイルコネクトSIMの場合
// =================================
{
  "CommonServiceItem": {
    "Name": "アマゾンで買ったSIM",
    "Status": {
      "ICCID": "898104XXXXXXXXXXXXX"
    },
    "Remark": {
      "PassCode": "XXXXXXXXXX"
    },
    "Provider": {
      "Class": "sim"
    }
  }
}

パラメータ

名前	型	省略	説明
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の共通サービス契約情報を取得

サンプル
- レスポンスボディ

// GSLBの場合
// ===========
{
  "CommonServiceItem": {
    "ID": "999999999999",
    "Name": "GSLB",
    "Description": "ほげほげ",
    "Settings": {
      "GSLB": {
        "DelayLoop": 10,
        "HealthCheck": {
          "Protocol": "https",
          "Host": "www.hogehoge.com",
          "Path": "/index.html",
          "Status": "200"
        },
        "Weighted": "True",
        "Servers": [
          {
            "IPAddress": "XXX.XXX.XXX.XXX",
            "Enabled": "True",
            "Weight": "10"
          },
          {
            "IPAddress": "XXX.XXX.XXX.XXX",
            "Enabled": "True"
          },
          {
            "IPAddress": "XXX.XXX.XXX.XXX",
            "Enabled": "False",
            "Weight": "100"
          },
          {
            "IPAddress": "XXX.XXX.XXX.XXX",
            "Enabled": "True",
            "Weight": "1"
          }
        ]
      }
    },
    "Status": {
      "FQDN": "site-999999999999.gslb1.sakura.ne.jp"
    },
    "Remark": null,
    "ServiceClass": "cloud/gslb",
    "CreatedAt": "2015-08-06T09:38:09+09:00",
    "ModifiedAt": "2015-08-06T09:38:09+09:00",
    "Provider": {
      "ID": 1000001,
      "Class": "gslb",
      "Name": "gslb1.sakura.ne.jp",
      "Availability": "disabled",
      "ServiceClass": "cloud/gslb"
    },
    "Icon": null,
    "Tags": []
  },
  "is_ok": true
}

// DNSの場合
// ===========
{
  "CommonServiceItem": {
    "ID": "999999999999",
    "Name": "fugafuga.com",
    "Description": "aaa",
    "Settings": {
      "DNS": {
        "ResourceRecordSets": [
          {
            "Name": "www",
            "Type": "A",
            "RData": "192.168.0.1",
            "TTL": 10
          },
          {
            "Name": "www2",
            "Type": "AAAA",
            "RData": "::1",
            "TTL": 3600
          },
          {
            "Name": "www3",
            "Type": "NS",
            "RData": "ns1.hogehoge.com.",
            "TTL": 3600
          },
          {
            "Name": "www4",
            "Type": "CNAME",
            "RData": "www.hogehoge.com.",
            "TTL": 3600
          },
          {
            "Name": "www5",
            "Type": "MX",
            "RData": "10 ns1.piyopiyo.com.",
            "TTL": 3600
          },
          {
            "Name": "www6",
            "Type": "TXT",
            "RData": "hogefugapiyo",
            "TTL": 3600
          }
        ]
      }
    },
    "Status": {
      "Zone": "fugafuga.com",
      "NS": [
        "ns1.gslb2.sakura.ne.jp",
        "ns2.gslb2.sakura.ne.jp"
      ]
    },
    "Remark": null,
    "ServiceClass": "cloud/dns",
    "CreatedAt": "2015-10-09T13:52:46+09:00",
    "ModifiedAt": "2015-10-09T13:52:46+09:00",
    "Provider": {
      "ID": 2000001,
      "Class": "dns",
      "Name": "gslb2.sakura.ne.jp",
      "Availability": "available",
      "ServiceClass": "cloud/dns"
    },
    "Icon": null,
    "Tags": []
  },
  "is_ok": true
}

// シンプル監視の場合
// ===============
{
  "CommonServiceItem": {
    "ID": "999999999999",
    "Name": "www.hogehoge.com",
    "Description": "ほげほげ",
    "Settings": {
      "SimpleMonitor": {
        "DelayLoop": 60,
        "HealthCheck": {
          "Protocol": "http",
          "Path": "/index.html",
          "Status": "200",
          "Port": "80"
        },
        "Enabled": "True",
        "NotifyEmail": {
          "Enabled": "True"
        },
        "NotifySlack": {
          "Enabled": "True",
          "IncomingWebhooksURL": "https://hooks.slack.com/services/XXXXXXXXX"
        }
      }
    },
    "Status": {
      "Target": "www.hogehoge.com"
    },
    "ServiceClass": "cloud/simplemon/free",
    "CreatedAt": "2015-12-15T11:41:30+09:00",
    "ModifiedAt": "2015-12-15T11:41:30+09:00",
    "Provider": {
      "ID": 3000001,
      "Class": "simplemon",
      "Name": "simplemon01",
      "ServiceClass": "cloud/simplemon"
    },
    "Icon": null,
    "Tags": []
  },
  "is_ok": true
}

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid

共通サービス契約を更新

ローカルルータの更新で接続先が「さくらのクラウド」でない場合、さくらインターネット会員メニューからログインした後、コントロールパネルからの操作が必要となります。

サンプル
- リクエストボディ

// GSLBの場合
// ===========
{
  "CommonServiceItem": {
    "Settings": {
      "GSLB": {
        "DelayLoop": "10",
        "HealthCheck": {
          "Protocol": "ping"
        },
        "Servers": [
          {
            "IPAddress": "192.168.0.1",
            "Enabled": "True"
          },
          {
            "IPAddress": "192.168.0.2",
            "Enabled": "True"
          },
          {
            "IPAddress": "192.168.0.3",
            "Enabled": "False"
          }
        ]
      }
    }
  }
}
// ### 補足事項
// - Enabledには、有効状態(True/False)を指定します。

// DNSの場合
// ==========
{
  "CommonServiceItem" : {
    "Settings" : {
      "DNS" : {
        "ResourceRecordSets" : [
          {
            "Name" : "hoge1",
            "Type" : "A",
            "RData" : "192.168.0.1",
            "TTL" : 10
          },
          {
            "Name" : "hoge2",
            "Type" : "AAAA",
            "RData" : "2001:db8::1"
          },
          {
            "Name" : "hoge3",
            "Type" : "CNAME",
            "RData" : "www.example.jp."
          },
          {
            "Name" : "hoge4",
            "Type" : "NS",
            "RData" : "ns1.example.jp."
          },
          {
            "Name" : "hoge5",
            "Type" : "MX",
            "RData" : "10 mail.example.jp."
          },
          {
            "Name" : "hoge6",
            "Type" : "TXT",
            "RData" : "This is test message"
          }
        ]
      }
    }
  }
}
// ### 補足事項
// - リソースレコードのTTLを省略した場合、デフォルトTTL(3,600秒)が適用されます。
//
// - MXレコードのRDataは、以下の形式で指定する必要があります。
// [MXプライオリティ] [FQDN]
//
// - NS, MX, CNAMEレコードのFQDNは、末尾がドット(.)で終わる必要があります。
//
// - その他、入力規則は以下URLをご覧ください
// http://cloud-news.sakura.ad.jp/cloud_dns/

// シンプル監視の場合
// ===========
{
  "CommonServiceItem": {
    "Settings": {
      "SimpleMonitor": {
        "DelayLoop": "60",
        "HealthCheck": {
          "Protocol": "tcp",
          "Port": "25"
        },
        "NotifyEmail": {
          "Enabled": "True"
        },
        "NotifySlack": {
          "Enabled": "True",
          "IncomingWebhooksURL": "https://hooks.slack.com/services/xxx/xxx/xxx"
        },
        "Enabled": "True"
      }
    }
  }
}

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

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

このAPIはシンプル監視のみ有効です。クラウド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/certificateauthority

該当IDの certificateauthority 設定情報を取得する

URLパラメータ

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

GET/commonserviceitem/:commonserviceitemid/certificateauthority/:action

該当IDの certificateauthority 設定情報を取得する

URLパラメータ

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

POST/commonserviceitem/:commonserviceitemid/certificateauthority/:action

該当IDの certificateauthority の servers, clients を登録する

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/certificateauthority/:action

該当IDの certificateauthority 実行/設定する

URLパラメータ

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

DELETE/commonserviceitem/:commonserviceitemid/certificateauthority/:action

該当IDの certificateauthority 削除/解除する

URLパラメータ

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

GET/commonserviceitem/:commonserviceitemid/certificateauthority/:action/:item

該当IDの certificateauthority 設定情報を取得する

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/certificateauthority/:action/:item

該当IDの certificateauthority 実行/設定する

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/certificateauthority/:action/:item/:item_action

該当IDの certificateauthority 実行/設定する

URLパラメータ

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

GET/commonserviceitem/:commonserviceitemid/containerregistry/:action

該当IDのさくら Container Registry 設定情報を取得する

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	+++ を取得する

POST/commonserviceitem/:commonserviceitemid/containerregistry/:action

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	+++ を設定する

PUT/commonserviceitem/:commonserviceitemid/containerregistry/:action

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	+++ を設定する

GET/commonserviceitem/:commonserviceitemid/containerregistry/:action/:item

該当IDのさくら Container Registry 設定情報を取得する

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	+++ を取得する

PUT/commonserviceitem/:commonserviceitemid/containerregistry/:action/:item

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	+++ を設定する

DELETE/commonserviceitem/:commonserviceitemid/containerregistry/:action/:item

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	+++ を削除する

GET/commonserviceitem/:commonserviceitemid/esme/:action

該当IDの esme 設定情報を取得する

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/esme/:action

該当IDの esme 実行/設定する

URLパラメータ

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

DELETE/commonserviceitem/:commonserviceitemid/esme/:action

該当IDの esme 削除/解除する

URLパラメータ

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

GET/commonserviceitem/:commonserviceitemid/esme/:action/:item

該当IDの esme 設定情報を取得する

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/esme/:action/:item

該当IDの esme 実行/設定する

URLパラメータ

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

GET/commonserviceitem/:commonserviceitemid/health

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

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

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/plan

該当IDの共通サービス契約のプランを変更

※プラン変更を行うとCommonServiceItem.IDが変わります。

URLパラメータ

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

GET/commonserviceitem/:commonserviceitemid/proxylb/:action

該当IDのさくらproxylb 設定情報を取得する

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	sslcertificate を取得する

PUT/commonserviceitem/:commonserviceitemid/proxylb/:action

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	sslcertificate を設定する

DELETE/commonserviceitem/:commonserviceitemid/proxylb/:action

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	sslcertificate を削除する

GET/commonserviceitem/:commonserviceitemid/sim/:action

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

URLパラメータ

Name	Comment
commonserviceitemid	共通サービス契約ID
action	status: SIMの状態を取得する metrics: SIMのトラフィック情報を取得する network_op eartor_config:マルチキャリアを取得する

PUT/commonserviceitem/:commonserviceitemid/sim/:action

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

サンプル
- リクエストボディ

// IMEIロックを行う例
// PUT /commonserviceitem/:commonserviceitemid/sim/imeilock
{
  "sim": {
    "imei": "XXXXXXXXXXXXXXX"
  }
}

// SIMにIPアドレスをアサインする例
// PUT /commonserviceitem/:commonserviceitemid/sim/ip
{
  "sim": {
    "ip": "192.168.0.11"
  }
}

URLパラメータ

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

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

POST/commonserviceitem/:commonserviceitemid/sms/:action

該当IDのフリーフォーマットSMS送信実行/設定する

URLパラメータ

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

PUT/commonserviceitem/:commonserviceitemid/sms/:action

該当IDのフリーフォーマットSMS送信実行/設定する

URLパラメータ

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

DELETE/commonserviceitem/:commonserviceitemid/sms/:action

該当IDのフリーフォーマットSMS送信削除/解除する

URLパラメータ

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

アプライアンス関連API

サンプル

サンプル

サンプル

URLパラメータ

サンプル

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

サンプル

URLパラメータ

パラメータ

URLパラメータ

サンプル

URLパラメータ

サンプル

パラメータ

オブジェクト構造

サンプル

URLパラメータ

サンプル

URLパラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ