Create Interface#
インターフェースを作成し、ポートにアタッチします。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://compute.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://compute.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
POST
/v2.1/{project_id}/servers/{server_id}/os-interface
HTTPステータスコード#
正常時:200
エラー時:400, 401, 403, 404, 409, 500, 501
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
project_id | path | string | 必須 | プロジェクトのUUID |
server_id | path | string | 必須 | サーバのUUID |
interfaceAttachment | body | object | 必須 | インターフェースのアタッチメント |
port_id | body | string | 任意※ | インターフェースを作成するポートのID 省略した場合は、portが自動的に割り当てられ、そこにインターフェースが作成されます。 ※port_idまたはnet_idのどちらか1つを指定してください。 |
net_id | body | string | 任意※ | インターフェースを作成するネットワークのID 省略した場合は、インターフェースがサーバに関連付けられているネットワークに作成されます。 ※port_idまたはnet_idのどちらか1つを指定してください。 |
fixed_ips | body | array | 任意 | 固定IP net_idを指定する場合だけ指定可能です。 |
ip_address | body | string | 任意 | IPアドレス |
tag | body | string | 任意 | ネットワークインターフェースに適用するタグ サーバのゲストOSによるメタデータとして参照できます。 📒注: マイクロバージョン2.49以上を指定してください。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
interfaceAttachment | object | インターフェースのアタッチメント |
fixed_ips | array | 固定IPアドレスとそのサブネットのID |
ip_address | string | IPアドレス |
subnet_id | string | サブネットのUUID |
mac_addr | string | MACアドレス |
net_id | string | ネットワークID |
port_id | string | ポートID |
port_state | string | ポートの状況 |
リクエスト例#
net_idとfixed_ipsを指定する場合
{ "interfaceAttachment": { "fixed_ips": [ { "ip_address": "192.168.1.3" } ], "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6" } }
ポートIDを指定する場合
{ "interfaceAttachment": { "port_id": "ce531f90-199f-48c0-816c-13e38010b442" } }
タグを指定する場合
{ "interfaceAttachment": { "port_id": "ce531f90-199f-48c0-816c-13e38010b442", "tag": "foo" } }
レスポンス例#
{ "interfaceAttachment": { "fixed_ips": [ { "ip_address": "192.168.1.3", "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef" } ], "mac_addr": "fa:16:3e:4c:2c:30", "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", "port_id": "ce531f90-199f-48c0-816c-13e38010b442", "port_state": "ACTIVE" } }