インタフェース関連API

GET /interface - インタフェース一覧を取得
POST /interface - インタフェースを作成
GET /interface/:interfaceid - 該当IDのインタフェース情報を取得
DELETE /interface/:interfaceid - 該当IDのインタフェースを削除
GET /interface/:interfaceid/monitor - ネットワーク流量のリソースモニタ情報を取得
DELETE /interface/:interfaceid/to/packetfilter - インタフェースへのパケットフィルタの割り当てを解除
PUT /interface/:interfaceid/to/packetfilter/:packetfilterid - インタフェースにパケットフィルタを割り当て
DELETE /interface/:interfaceid/to/switch - インタフェースとスイッチの接続を解除
PUT /interface/:interfaceid/to/switch/:switchid - インタフェースとスイッチを接続
PUT /interface/:interfaceid/to/switch/shared - インタフェースから共有セグメントに接続
GET /packetfilter - パケットフィルタ一覧を取得
POST /packetfilter - パケットフィルタを作成
GET /packetfilter/:packetfilterid - 該当IDのパケットフィルタ情報を取得
PUT /packetfilter/:packetfilterid - 該当IDのパケットフィルタ情報を更新
DELETE /packetfilter/:packetfilterid - 該当IDのパケットフィルタを削除

GET/interface

インタフェース一覧を取得

サンプル
- curl

ネットワークインターフェース(NIC)の一覧を取得します。

curl

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

POST/interface

インタフェースを作成

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

複数のスイッチに接続するにはインターフェースを追加する必要があります。サーバが起動している時はインターフェースを追加することはできません。 1サーバに最大4個までインタフェースを追加できます。

リクエストボディ

{
  "Interface":{
    "Server":{
      "ID":"XXXXXXXXXXXX"
    }
  },
  "Count":0
}

curl

curl --user "Access Token":"Access Token Secret" -X POST \
     -d '{"Interface":{"Server":{"ID":"XXXXXXXXXXXX"}}}' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.0/interface

パラメータ

名前	型	省略	説明
[Interface.Server.ID]	int	可	インタフェースを増設するサーバのID

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○			ID : int
○	○			MACAddress : string
○				IPAddress : ipaddress
○	○	○	○	UserIPAddress : ipaddress
○	○	○		Server.ID : int
○				Server.ServerPlan.ServiceClass : string
○	○			Server.ServerPlan.Availability : EAvailability
○				Server.Zone.Description : string
○				Server.Zone.Region.Description : string
○				Server.Zone.Region.NameServers : string
○				Server.Instance.BeforeStatus : EServerInstanceStatus
○				Server.Instance.StatusChangedAt : date
○				Server.Instance.Host.Zone.Description : string
○				Server.Instance.Host.Zone.Region.Description : string
○				Server.Instance.Host.Zone.Region.NameServers : string
○				Server.Instance.CDROM.Description : string
○	○			Server.Instance.CDROM.Availability : EAvailability
○				Server.Instance.CDROM.ServiceClass : string
○				Server.Instance.CDROMStorage.Description : string
○				Server.Instance.CDROMStorage.Zone.Description : string
○				Server.Instance.CDROMStorage.Zone.Region.Description : string
○				Server.Instance.CDROMStorage.Zone.Region.NameServers : string
○	○	○		Switch.ID : int
○				Switch.Description : string
○				Switch.ServerCount : int
○				Switch.ServiceClass : string
○				Switch.Zone.Description : string
○				Switch.Zone.Region.Description : string
○				Switch.Zone.Region.NameServers : string
○				Switch.Subnets.NetworkAddress : string
○				Switch.Subnets.DefaultRoute : string
○				Switch.Subnets.ServiceClass : string
○				Switch.Subnets.Internet.ID : int
○				Switch.Subnets.Internet.Name : string
○				Switch.Subnets.Internet.BandWidthMbps : int
○				Switch.Subnets.Internet.ServiceClass : string

GET/interface/:interfaceid

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

サンプル
- curl

curl

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

URLパラメータ

Name	Comment
interfaceid	インタフェースID

DELETE/interface/:interfaceid

該当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/interface/:interfaceid

URLパラメータ

Name	Comment
interfaceid	インタフェースID

GET/interface/:interfaceid/monitor

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

サンプル
- curl

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

curl

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

URLパラメータ

Name	Comment
interfaceid	インタフェースID

パラメータ

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

DELETE/interface/:interfaceid/to/packetfilter

インタフェースへのパケットフィルタの割り当てを解除

URLパラメータ

Name	Comment
interfaceid	インタフェースID
packetfilterid	パケットフィルタID

PUT/interface/:interfaceid/to/packetfilter/:packetfilterid

インタフェースにパケットフィルタを割り当て

URLパラメータ

Name	Comment
interfaceid	インタフェースID
packetfilterid	パケットフィルタID

DELETE/interface/:interfaceid/to/switch

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

サンプル
- curl

curl

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

URLパラメータ

Name	Comment
interfaceid	インタフェースID

PUT/interface/:interfaceid/to/switch/:switchid

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

サンプル
- curl

curl

curl --user "Access Token":"Access Token Secret" -X PUT -d '' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/interface/:interfaceid/to/switch/:switchid

URLパラメータ

Name	Comment
interfaceid	インタフェースID
switchid	スイッチID

PUT/interface/:interfaceid/to/switch/shared

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

サンプル
- curl

curl

curl --user "Access Token":"Access Token Secret" -X PUT -d '' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/interface/:interfaceid/to/switch/shared

URLパラメータ

Name	Comment
interfaceid	インタフェースID

GET/packetfilter

パケットフィルタ一覧を取得

POST/packetfilter

パケットフィルタを作成

パラメータ

名前	型	省略	説明
PacketFilter.Name	string	不可	パケットフィルタ名
[PacketFilter.Description]	string	可	説明

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○			ID : int
○	○	○	○	Name : string	○		1~64文字
○	○	○	○	Description : string		空文字	512文字
○	○	○	○	Expression : json
○	○	○	○	Notice : json

GET/packetfilter/:packetfilterid

該当IDのパケットフィルタ情報を取得

URLパラメータ

Name	Comment
packetfilterid	パケットフィルタID

PUT/packetfilter/:packetfilterid

該当IDのパケットフィルタ情報を更新

サンプル
- リクエスト

情報は上書きされます。Expressionの扱いに注意してください

リクエストボディ

{
  "PacketFilter":{
    "Expression":[{
      "Protocol":"tcp",
      "SourceNetwork":"XXX.XXX.XXX.XXX",
      "DestinationPort":XX,
      "Action":"allow"}
    ]},
  "Count":0
}

URLパラメータ

Name	Comment
packetfilterid	パケットフィルタID

パラメータ

名前	型	省略	説明
[PacketFilter.Name]	string	可	パケットフィルタ名
[PacketFilter.Description]	string	可	説明
[PacketFilter.Expression.Protocol]	string	可	tcp,udp,ipのどれか。Expression指定時は省略不可
[PacketFilter.Expression.SourceNetwork]	string	可	送信元ネットワーク Expression指定時は省略不可
[PacketFilter.Expression.DestinationPort]	int	可	宛先ポート
[PacketFilter.Expression.Action]	string	可	allow,denyのどちらか

DELETE/packetfilter/:packetfilterid

該当IDのパケットフィルタを削除

URLパラメータ

Name	Comment
packetfilterid	パケットフィルタID