CreateNetworkInterface
処理概要
追加NICを新規作成します。1回のリクエストで、1つの追加NICを作成できます。
追加NICの作成には時間がかかることがあります。このAPIのレスポンス「status」を確認し「processing」が返ってきた、またはタイムアウトした場合はAPI「DescribeNetworkInterfaces」のレスポンス値「status」で追加NICのステータスを確認できます。
APIのパラメーター「NiftyNetworkId」の指定できるのは、プライベートLANのネットワークユニークIDです。共通グローバルや共通プライベートやプライベートLAN(旧)のネットワークユニークIDを指定した場合、エラーが返されます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| NiftyNetworkId | ネットワークユニークID Type : String 値:プライベートLANのネットワークユニークID |
○ | net-0v3nmuh8 |
| IpAddress | IPアドレス Type : String 1）指定されたネットワークがプライベートLANでDHCPが有効化されている 値 : IPアドレス | static(手動化) Default : DHCPによるIPアドレス自動発行 2）指定されたネットワークがプライベートLANでDHCPが無効化されている 値 : static(手動化) |
||
| Placement.AvailabilityZone | ゾーン情報 Type : String Default : ニフクラが決定 |
east-12 | |
| Description | メモ情報 Type : String |
応答フィールド
| フィールド(項目) | 説明 | サンプル値 |
|---|---|---|
| CreateNetworkInterfaceResponse | CreateNetworkInterface レスポンス Type : CreateNetworkInterfaceResponseType Ancestor : なし Children : requestId, return, networkInterface |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : CreateNetworkInterfaceResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| return | 処理ステータス Type : xsd:boolean 値:true (成功) Ancestor : CreateNetworkInterfaceResponse Children : なし |
|
| networkInterface | ネットワークインターフェースの情報 Type : NetworkInterfaceType Ancestor : CreateNetworkInterfaceResponse Children : association, attachment, availabilityZone, description, groupSet, interfaceType, ipv6AddressesSet, macAddress, networkInterfaceId, ownerId, privateDnsName, privateIpAddress, privateIpAddressesSet, requesterId, requesterManaged, sourceDestCheck, status, subnetId, tagSet, vpcId, niftyNetworkId, niftyNetworkName |
|
| association | 付替IPの関連付け情報 Type : AssociationType Ancestor : networkInterface Children : allocationId, associationId, ipOwnerId, publicDnsName, publicIp |
|
| allocationId | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| associationId | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| ipOwnerId | ※返却値なし Type : nxsd:string Ancestor : association Children : なし |
|
| publicDnsName | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| publicIp | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| attachment | サーバーへの割り当て情報 Type : AttachmentType Ancestor : networkInterface Children : attachmentId, attachTime, deleteOnTermination, deviceIndex, instanceId, instanceOwerId, status |
|
| attachmentId | アタッチメントID Type : xsd:string Ancestor : attachment Children : なし |
iniatc-2ab04f80 |
| attachTime | サーバーへの接続時刻 Type : xsd:string Ancestor : attachment Children : なし |
2017-09-25T07:45:31.547+09:00 |
| deleteOnTermination | ※空を返却 Type : xsd:boolean Ancestor : attachment Children : なし |
false |
| deviceIndex | デバイス番号 Type : xsd:string Ancestor : attachment Children : なし |
|
| instanceId | サーバー名 Type : xsd:string Ancestor : item Children : なし |
server01 |
| instanceOwnerId | ※空を返却 Type : xsd:string Ancestor : attachment Children : なし |
|
| status | ネットワークインターフェースのステータス Type : xsd:string 値 : attached(接続済) Ancestor : attachment Children : なし |
|
| availabilityZone | ゾーン情報 Type : xsd:string Ancestor : networkInterface Children : なし |
east-12 |
| description | メモ情報(CDATA付) Type : xsd:string Ancestor : networkInterface Children : なし |
|
| groupSet | ファイアウォール情報セット Type : GroupSetType Ancestor : networkInterface Children : item |
|
| item | ファイアウォール情報 Type : GroupItemType Ancestor : groupSet Children : groupId |
|
| groupId | ファイアウォールグループ名 ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| interfaceType | ネットワークインターフェースタイプ Type : xsd:string Ancestor : networkInterface Children:なし |
|
| ipv6AddressesSet | グローバルIPアドレス(IPv6)情報セット Type : Ipv6AddressesSetType Ancestor : networkInterface Children : item |
|
| item | グローバルIPアドレス(IPv6)情報 Type : Ipv6AddressesItemType Ancestor : ipv6AddressesSet Children : ipv6Address |
|
| ipv6Address | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| macAddress | MACアドレス Type : xsd:string Ancestor : networkInterface Children : なし |
|
| networkInterfaceId | ネットワークインターフェースID Type : xsd:string Ancestor : networkInterface Children : なし |
ni-3db04f80 |
| ownerId | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| privateDnsName | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| privateIpAddress | プライベートIPアドレス Type : xsd:string Ancestor : networkInterface Children : なし |
10.0.5.111 |
| privateIpAddressesSet | プライベートIPアドレス(IPv4)情報セット Type : PrivateIpAddressesSetType Ancestor : networkInterface Children : item |
|
| item | プライベートIPアドレス(IPv4)情報 Type : PrivateIpAddressesItemType Ancestor : privateIpAddressesSet Children : association, primary, privateDnsName, privateIpAddress |
|
| association | プライベートIPアドレス(IPv4)のネットワークインターフェース関連付け情報 Type : networkInterfaceAssociationType Ancestor : item Children : allocationId, associationId, ipOwnerId, publicDnsName, publicIp |
|
| allocationId | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| associationId | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| ipOwnerId | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| publicDnsName | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| publicIp | ※返却値なし Type : xsd:string Ancestor : association Children : なし |
|
| primary | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| privateDnsName | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddress | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| requesterId | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| requesterManaged | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| sourceDestCheck | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| status | ネットワークインターフェースのステータス Type : xsd:string 値 : available(利用可能) | in-use(使用中) | processing (処理中) Ancestor : networkInterface Children : なし |
available |
| subnetId | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| tagSet | リソースに設定されているタグ情報セット Type : ResourceTagSetType Ancestor : networkInterface Children : item |
|
| item | リソースに設定されているタグ情報 Type : ResourceTagSetItemType Ancestor : tagSet Children : key, value |
|
| key | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| value | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| vpcId | ※返却値なし Type : xsd:string Ancestor : networkInterface Children : なし |
|
| niftyNetworkId | ネットワークユニークID Type : xsd:string Ancestor : networkInterface Children : なし |
net-0v3nmuh8 |
| niftyNetworkName | ネットワーク名 Type : xsd:string Ancestor : networkInterface Children : なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=CreateNetworkInterface&NiftyNetwokrId=net-0v3nmuh8&IpAddress=10.0.5.111&Placement.AvailabilityZone=east-12&description=memo&CommonParams
応答サンプル
<CreateNetworkInterfaceResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
<networkInterface>
<association>
<allocationId/>
<associationId/>
<ipOwnerId/>
<publicDnsName/>
<publicIp/>
</association>
<attachment>
<attachmentId/>
<attachTime/>
<deleteOnTermination/>
<deviceIndex/>
<instanceId/>
<instanceOwnerId/>
<status/>
</attachment>
<availabilityZone>east-12</availabilityZone>
<description><![CDATA[memo]]></description>
<groupSet>
<item>
<groupId/>
</item>
</groupSet>
<interfaceType>interface</interfaceType>
<ipv6AddressesSet>
<item>
<ipv6Address/>
</item>
</ipv6AddressesSet>
<macAddress>07:00:30:1B:92:44</macAddress>
<networkInterfaceId>ni-3db04f80</networkInterfaceId>
<ownerId/>
<privateDnsName/>
<privateIpAddress>10.0.5.111</privateIpAddress>
<privateIpAddressesSet>
<item>
<association>
<allocationId/>
<associationId/>
<ipOwnerId/>
<publicDnsName/>
<publicIp/>
</association>
<primary/>
<privateDnsName/>
<privateIpAddress/>
</item>
</privateIpAddressesSet>
<requesterId/>
<requesterManaged/>
<sourceDestCheck/>
<status>available</status>
<subnetId/>
<tagSet>
<item>
<key/>
<value/>
</item>
</tagSet>
<vpcId/>
<niftyNetworkId>net-0v3nmuh8</niftyNetworkId>
<niftyNetworkName>prilan1</niftyNetworkName>
</networkInterface>
</CreateNetworkInterfaceResponse>
