ページの先頭行へ戻る
Cloud Storage Gateway V1.3.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.6 ネットワーク
前次

1.2.6 ネットワーク

1.2.6.1 GET /v1/networks

機能

ネットワークインターフェイス一覧

処理概要

OSで認識しているネットワークインターフェイスの一覧を表示します。

1つ目のネットワークのネットワークIDは、常に0となります。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

フィルターするカラム名を指定します。
“,”で連結して複数のカラムを指定できます。

[例]
id,dhcp

任意

string

query

filter_vals

filter_colsパラメーターで指定したカラム名に対して、指定順にフィルターの条件を指定します。
数値の場合、“~”で範囲を指定できます。

[例]
1~*,Disable

任意

string

query

sort_cols

ソートするカラム名を指定します。

[例]
id,dhcp

任意

string

query

sort_vals

sort_colsパラメーターで指定したカラム名に対して、指定順にソートの条件を指定します。

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

表示するカラム名を指定します。

[例]
id,dhcp

任意

string

query

hide_cols

非表示にするカラム名を指定します。

[例]
id,dhcp

任意

string

query

limit

表示する項目数を指定します。

任意

integer

query

offset

項目の表示開始位置を指定します。

任意

integer

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

表示

形式

列挙型定数

200

configured

ネットワークインターフェイスの設定の状態

  • true: 設定済み

  • false: 未設定

Yes

boolean

id

ネットワークID

Yes

integer

network_name

ネットワーク名

Yes

string

mac_address

MACアドレス

Yes

string

dhcp

DHCPの有効/無効

Yes

enum

Enable:
DHCPが有効に設定されています。

Disable:
DHCPは無効に設定されています。

ip_address

IPアドレス

Yes

string

subnet_mask

サブネットマスク

Yes

string

gateway_address

ゲートウェイ

Yes

string

実行例

# curl -X GET \
  -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
 'https://192.0.2.10:9856/v1/networks'

1.2.6.2 POST /v1/networks

機能

ネットワーク登録

処理概要

2つ目以降のネットワークを登録します。

1つ目のネットワークは登録できません。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

network_name

ネットワーク名を指定します。
省略時は、“NET#nn”という名前が設定されます。
nnには、01から始まる2桁の数字が入ります。
すでに存在しているネットワーク名は指定できません。

  • 使用可能文字: 半角英数字

  • 使用可能記号: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

  • 文字数: 1～32

[例]
NET#01

任意

string

query

mac_address

MACアドレスを指定します。

  • 使用可能文字: 半角英数字

  • 使用可能記号: :

  • 文字数: 17

[例]
a1:b2:c3:d4:e5:f6

必須

string

query

dhcp

DHCPの有効/無効を設定します。

  • Enable: DHCPの有効化

  • Disable: DHCPの無効化

省略時は、“Disable”を指定したものとみなします。

任意

enum

query

ip_address

IPアドレスを指定します。
DHCPを無効に設定した場合に必須です。

[例]
192.168.1.10

任意

string

query

subnet_mask

サブネットマスクを指定します。
DHCPを無効に設定した場合に必須です。

[例]
255.255.255.0

任意

string

query

gateway_address

ゲートウェイのIPアドレスを指定します。
DHCPを無効に設定した場合にゲートウェイを指定できます。

[例]
192.168.1.1

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

network_name

ネットワーク名

string

mac_address

MACアドレス

string

dhcp

DHCP設定の有効/無効

enum

Enable:
DHCPが有効に設定されています。

Disable:
DHCPは無効に設定されています。

ip_address

IPアドレス

string

subnet_mask

サブネットマスク

string

gateway_address

ゲートウェイ

string

実行例

1.2.6.3 PUT /v1/networks/{id}

機能

ネットワーク変更

処理概要

ネットワークを変更します。

1つ目のネットワークはネットワーク名だけ変更できます。

MACアドレスは変更できません。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

ネットワークIDを指定します。

必須

integer

path

network_name

ネットワーク名を指定します。
すでに存在しているネットワーク名は指定できません。

  • 使用可能文字: 半角英数字

  • 使用可能記号: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

  • 文字数: 1～32

[例]
NET#01

任意

string

query

dhcp

DHCPの有効/無効を設定します。

  • Enable: DHCPの有効化

  • Disable: DHCPの無効化

任意

enum

query

ip_address

IPアドレスを指定します。
DHCPを無効に設定した場合にIPアドレスを指定します。

[例]
192.168.1.10

任意

string

query

subnet_mask

サブネットマスクを指定します。
DHCPを無効に設定した場合にサブネットマスクを指定します。

[例]
255.255.255.0

任意

string

query

gateway_address

ゲートウェイを指定します。
DHCPを無効に設定した場合にゲートウェイを指定できます。

[例]
192.168.1.1

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

ネットワークのID

string

network_name

ネットワーク名

string

dhcp

DHCP設定の有効/無効

enum

Enable:
DHCPが有効に設定されています。

Disable:
DHCPは無効に設定されています。

ip_address

IPアドレス

string

subnet_mask

サブネットマスク

string

gateway_address

ゲートウェイ

string

実行例

IDが1のネットワークの名前を「Network#01」に変更する場合

# curl -X PUT \
   -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
   -d 'network_name=Network#01' \
 'https://192.0.2.10:9856/v1/networks/1'

1.2.6.4 DELETE /v1/networks

機能

ネットワーク削除

処理概要

ネットワークを削除します。

クラウドプロバイダーとの通信に使用しているネットワークは削除できません。強制的に削除したい場合は“force”に“true”を指定してください。

1つ目のネットワークは削除できません。“force”に“true”を指定しても削除できません。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

ids

削除するネットワークIDを指定します。
“,”(コンマ)区切りで複数指定できます。

[例]
1,2

必須

string

query

force

強制削除する場合に指定します。

  • 選択: [true | false]

“true”を指定した場合は、クラウドプロバイダーへの割当て状態にかかわらず削除します。“false”を指定した場合は、削除しません。

省略時は、“false”を指定したものとみなします。

[例]
true

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

ids

削除されたネットワークID(数値)

string

実行例

IDが1のネットワークを削除する場合

# curl -X DELETE \
   -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
   -d 'ids=1' \
 'https://192.0.2.10:9856/v1/networks'
前次
Copyright FUJITSU LIMITED 2018-2021