ルータ関連API

GET /internet - インターネット接続一覧を取得
POST /internet - ルータ+スイッチを作成
GET /internet/:internetid - 該当IDのインターネット接続情報を取得
PUT /internet/:internetid - インターネット接続を更新
DELETE /internet/:internetid - 該当IDのインターネット接続を削除
PUT /internet/:internetid/bandwidth - 該当IDのルータの回線帯域幅を変更
GET /ipaddress - IPアドレス一覧を取得
GET /ipaddress/:ipaddress - 該当IDのIPアドレス情報を取得
PUT /ipaddress/:ipaddress - IPアドレス情報を更新
GET /subnet - サブネット一覧を取得
GET /subnet/:subnetid - 該当IDのサブネット情報を取得

GET/internet

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

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

レスポンスボディ

{
  "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

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

POST/internet

ルータ+スイッチを作成

サンプル
- リクエスト
- curl

リクエストボディ

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

curl

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

パラメータ

名前	型	省略	説明
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
○				ServiceClass : string
○				Zone.ID : int
○				Zone.Description : string
○				Zone.Region.Description : string
○				Zone.Region.NameServers : string
○				Subnet.DefaultRoute : string
○				Subnet.ServiceClass : string

GET/internet/:internetid

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

サンプル
- curl

curl

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

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

サンプル
- リクエスト
- curl

リクエストボディ

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

curl

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

URLパラメータ

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

パラメータ

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

DELETE/internet/:internetid

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

サンプル
- curl

curl

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

curl

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

URLパラメータ

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

パラメータ

名前	型	省略	説明
BandWidthMbps	int	不可

GET/ipaddress

IPアドレス一覧を取得

サンプル
- curl

curl

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

curl

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

サブネット一覧を取得

サンプル
- curl

curl

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

GET/subnet/:subnetid

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

サンプル
- curl

curl

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