ルータ関連API

GET

/internet

-

インターネット接続一覧を取得
POST

/internet

-

ルータ＋スイッチを作成
GET

/internet/:internetid

-

該当IDのインターネット接続情報を取得
PUT

/internet/:internetid

-

インターネット接続を更新
DELETE

/internet/:internetid

-

該当IDのインターネット接続を削除
PUT

/internet/:internetid/bandwidth

-

該当IDのルータの回線帯域幅を変更
POST

/internet/:internetid/ipv6net

-

ルータ＋スイッチにIPv6ネットワークを割り当てる。
DELETE

/internet/:internetid/ipv6net/:ipv6netid

-

ルータ＋スイッチに割り当てられたIPv6ネットワークを削除する。
GET

/internet/:internetid/monitor

-

ネットワーク流量のリソースモニタ情報を取得
POST

/internet/:internetid/subnet

-

ルータ＋スイッチに追加のIPアドレスブロックを割り当てる。
PUT

/internet/:internetid/subnet/:subnetid

-

ルータ＋スイッチに追加したIPアドレスブロック情報を変更する。
DELETE

/internet/:internetid/subnet/:subnetid

-

ルータ＋スイッチに追加したIPアドレスブロックを削除する。
GET

/internet/:internetid/tag

-

該当IDのインターネットに付けられたタグを取得
PUT

/internet/:internetid/tag

-

該当IDのインターネットに付けられるタグを変更
GET

/internet/tag

-

インターネットタグ一覧を取得
GET

/ipaddress

-

IPアドレス一覧を取得
GET

/ipaddress/:ipaddress

-

該当IDのIPアドレス情報を取得
PUT

/ipaddress/:ipaddress

-

IPアドレス情報を更新
GET

/ipv6addr

-

IPv6アドレス一覧を取得
POST

/ipv6addr

-

IPv6アドレスを登録
GET

/ipv6addr/:ipv6addr

-

該当IDのIPv6アドレス情報を取得
PUT

/ipv6addr/:ipv6addr

-

IPv6アドレス情報を更新
DELETE

/ipv6addr/:ipv6addr

-

IPv6アドレスを削除する
GET

/ipv6net

-

IPv6ネットワーク一覧を取得
GET

/ipv6net/:ipv6netid

-

該当IDのIPv6ネットワーク情報を取得
GET

/subnet

-

サブネット一覧を取得
GET

/subnet/:subnetid

-

該当IDのサブネット情報を取得

GET/internet

インターネット接続一覧を取得

サンプル

{
  "From":0,
  "Count":1,
  "Total":1,
  "Internet":[
    {
      "Index":0,
      "ID":XXXXXXXXXXXX,
      "Name":"名前",
      "Description":"説明文",
      "BandWidthMbps":500,
      "NetworkMaskLen":28,
      "Scope":"user",
      "ServiceClass":"cloud/internet/router/500m",
      "CreatedAt":"2012-12-19T17:10:51+09:00",
      "Zone":{
        "ID":31001,
        "Name":"is1a",
        "Description":"石狩Aゾーン",
        "VNCProxy":{
          "HostName":"sac-is1a-ssl.sakura.ad.jp",
          "IPAddress":"XXX.XXX.XXX.XXX"
        },
        "FTPServer":{
          "HostName":"sac-is1a-ssl.sakura.ad.jp",
          "IPAddress":"XXX.XXX.XXX.XXX"
        },
        "Region":{
          "ID":310,
          "Name":"石狩",
          "Description":"石狩",
          "NameServers":[
            "XXX.XXX.XXX.XXX",
            "XXX.XXX.XXX.XXX"
          ]
        }
      },
      "Subnet":{
      "ID":XXX,
      "Switch":{"ID":XXXXXXXXXXXX},
      "NetworkAddress":"XXX.XXX.XXX.XXX",
      "NetworkMaskLen":XX,
      "DefaultRoute":XXX.XXX.XXX.XXX,
      "ServiceClass":"cloud/global-ipaddress-v4/28"
      }
    }
  ],
  "is_ok":true
}

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

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

POST/internet

ルータ＋スイッチを作成

サンプル

{
  "Internet":{
    "Name":"Name",
    "Description":"Description",
    "NetworkMaskLen":28,
    "BandWidthMbps":100
  },
  "Count":0
}

curl --user "Access Token":"Access Token Secret" -X POST \
     -d '{"Internet":{"Name":"Name","Description":"Description","NetworkMaskLen":28,"BandWidthMbps":100}}' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet

curl -k --user "Access Token":"Access Token Secret" -X POST ^
     -d "{\"Internet\":{\"Name\":\"Name\",\"Description\":\"Description\",\"NetworkMaskLen\":28,\"BandWidthMbps\":100}}" ^
     -H "Content-type: application/json" ^
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet

パラメータ

名前	型	省略	説明
Internet.Name	string	不可	ルータ名
[Internet.Description]	string	可	説明
Internet.NetworkMaskLen	int	不可	プレフィックス(28,27)
Internet.BandWidthMbps	int	不可	帯域幅(100,500,1000)

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○			ID : int
○	○	○	○	Name : string	○		1~64文字
○	○	○	○	Description : string		空文字	512文字
○	○	○		BandWidthMbps : int	○
○	○	○		NetworkMaskLen : int	○
○	○			Scope : EScope
○				ServiceClass : string
○	○	○	○	Icon.ID : int
○	○	○		Zone.ID : int
○				Zone.Description : string
○				Zone.IsDummy : bool
○				Zone.Region.Description : string
○				Zone.Region.NameServers : string
○	○	○		Switch.ID : int
○				Switch.Subnets.DefaultRoute : ipaddress

GET/internet/:internetid

該当IDのインターネット接続情報を取得

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

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

curl -k --user "Access Token":"Access Token Secret" ^
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid

URLパラメータ

Name	Comment
internetid	インターネット接続ID

PUT/internet/:internetid

インターネット接続を更新

サンプル

{
  "Internet":{
    "Name":"New Name",
    "Description":"New Description"
  },
  "Count":0
}

curl --user "Access Token":"Access Token Secret" -X PUT \
     -d '{"Internet":{"Name":"Name","Description":"Description"}}' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid

curl -k --user "Access Token":"Access Token Secret" -X PUT ^
     -d "{\"Internet\":{\"Name\":\"Name\",\"Description\":\"Description\"}}" ^
     -H "Content-type: application/json" ^
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid

URLパラメータ

Name	Comment
internetid	インターネット接続ID

パラメータ

名前	型	省略	説明
[Internet.Name]ルータ名	string	可
[Internet.Description]	string	可	説明

DELETE/internet/:internetid

該当IDのインターネット接続を削除

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

curl --user "Access Token":"Access Token Secret" -X DELETE -d '' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid

curl -k --user "Access Token":"Access Token Secret" -X DELETE -d '' ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid

URLパラメータ

Name	Comment
internetid	インターネット接続ID

PUT/internet/:internetid/bandwidth

該当IDのルータの回線帯域幅を変更

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

# 帯域幅を500Mbpsに変更する例(帯域幅は100,500,1000が選べます)
curl --user "ACCESS TOKEN":"Access Token Secret" -X PUT \
     -d '{"Internet":{"BandWidthMbps":500}}' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid/bandwidth
# ※これはプラン変更になりますので、実行後に サービスコードが変更されます

# 帯域幅を500Mbpsに変更する例(帯域幅は100,500,1000が選べます)
curl -k --user "ACCESS TOKEN":"Access Token Secret" -X PUT ^
     -d "{\"Internet\":{\"BandWidthMbps\":500}}" ^
     -H "Content-type: application/json" ^
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/internet/:internetid/bandwidth
# ※これはプラン変更になりますので、実行後に サービスコードが変更されます

URLパラメータ

Name	Comment
internetid	インターネット接続ID

パラメータ

名前	型	省略	説明
BandWidthMbps	int	不可

POST/internet/:internetid/ipv6net

ルータ＋スイッチにIPv6ネットワークを割り当てる。

URLパラメータ

Name	Comment
internetid	インターネット接続ID

パラメータ

名前	型	省略	説明
[IPv6PrefixLen]	int	可	プレフィックス（省略時は64）

DELETE/internet/:internetid/ipv6net/:ipv6netid

ルータ＋スイッチに割り当てられたIPv6ネットワークを削除する。

URLパラメータ

Name	Comment
internetid	インターネット接続ID
ipv6netid	サブネットID

GET/internet/:internetid/monitor

ネットワーク流量のリソースモニタ情報を取得

URLパラメータ

Name	Comment
interfaceid	インタフェースID

パラメータ

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

POST/internet/:internetid/subnet

ルータ＋スイッチに追加のIPアドレスブロックを割り当てる。

URLパラメータ

Name	Comment
internetid	インターネット接続ID

パラメータ

名前	型	省略	説明
NetworkMaskLen	int	不可	プレフィックス(28,27)
[NextHop]	ipaddress	可	スタティックルートのネクストホップIPアドレス

PUT/internet/:internetid/subnet/:subnetid

ルータ＋スイッチに追加したIPアドレスブロック情報を変更する。

URLパラメータ

Name	Comment
internetid	インターネット接続ID
subnetid	サブネットID

パラメータ

名前	型	省略	説明
[NextHop]	ipaddress	可	スタティックルートのネクストホップIPアドレス

DELETE/internet/:internetid/subnet/:subnetid

ルータ＋スイッチに追加したIPアドレスブロックを削除する。

URLパラメータ

Name	Comment
internetid	インターネット接続ID
subnetid	サブネットID

GET/internet/:internetid/tag

該当IDのインターネットに付けられたタグを取得

PUT/internet/:internetid/tag

該当IDのインターネットに付けられるタグを変更

GET/internet/tag

インターネットタグ一覧を取得

GET/ipaddress

IPアドレス一覧を取得

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

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

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

GET/ipaddress/:ipaddress

該当IDのIPアドレス情報を取得

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

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

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

URLパラメータ

Name	Comment
ipaddress	IPアドレス

PUT/ipaddress/:ipaddress

IPアドレス情報を更新

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

{
  "IPAddress":{
    "HostName":"HostName"
  },  
  "Count":0
}

URLパラメータ

Name	Comment
ipaddress	IPアドレス

GET/ipv6addr

IPv6アドレス一覧を取得

POST/ipv6addr

IPv6アドレスを登録

パラメータ

名前	型	省略	説明
IPv6Addr.IPv6Addr	string	不可	IPv6アドレス
[IPv6Addr.HostName]	string	可	ホスト名
IPv6Addr.IPv6Net.ID	int	不可	IPv6アドレス登録先ネットワークID

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○	○		IPv6Addr : ipv6addr
○	○	○	○	HostName : string			255文字
○	○			IPv6Net.ID : int

GET/ipv6addr/:ipv6addr

該当IDのIPv6アドレス情報を取得

URLパラメータ

Name	Comment
ipv6addr	IPv6アドレス

PUT/ipv6addr/:ipv6addr

IPv6アドレス情報を更新

URLパラメータ

Name	Comment
ipv6addr	IPv6アドレス

DELETE/ipv6addr/:ipv6addr

IPv6アドレスを削除する

URLパラメータ

Name	Comment
ipv6addr	IPv6アドレス

GET/ipv6net

IPv6ネットワーク一覧を取得

GET/ipv6net/:ipv6netid

該当IDのIPv6ネットワーク情報を取得

URLパラメータ

Name	Comment
ipv6netid	IPv6ネットワークID

GET/subnet

サブネット一覧を取得

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

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

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

GET/subnet/:subnetid

該当IDのサブネット情報を取得

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

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

curl -k --user "Access Token":"Access Token Secret" ^
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/subnet/:subnetid

URLパラメータ

Name	Comment
subnetid	サブネットID

ルータ関連API

サンプル

サンプル

パラメータ

オブジェクト構造

サンプル

URLパラメータ

サンプル

URLパラメータ

パラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

パラメータ

URLパラメータ

サンプル

サンプル

URLパラメータ

サンプル

URLパラメータ

パラメータ

オブジェクト構造

URLパラメータ

URLパラメータ

URLパラメータ

URLパラメータ

サンプル

サンプル

URLパラメータ