NiftyCreateWebProxy
処理概要
指定したルーターに対してWebプロキシを新規作成します。
受け側/迂回先ネットワークは、ルーターと紐付きのあるネットワークを指定する必要があります。
ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
RouterId | string |
ルーターユニークID |
○ (ルーター名といずれか) |
RouterName | string |
ルーター名 |
○ (ルーターユニークIDといずれか) |
ListenInterface.NetworkId | string |
Webプロキシの受け側ネットワークID |
○ (Webプロキシの受け側ネットワーク名といずれか) |
ListenInterface.NetworkName | string |
Webプロキシの受け側ネットワーク名 |
○ (Webプロキシの受け側ネットワークIDといずれか) |
ListenPort | string |
Webプロキシのポート |
○ |
BypassInterface.NetworkId | string |
Webプロキシの迂回先ネットワークID |
|
BypassInterface.NetworkName | string |
Webプロキシの迂回先ネットワーク名 |
|
Option.NameServer | string |
DNSサーバのアドレス(IPv4) Default: ニフクラが決定 |
|
Description | string |
メモ |
|
Agreement | boolean |
version up実施したのち、バックアップ状態を解除する事項への同意 値:
|
○ (バックアップを保持する場合のみ) |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
NiftyCreateWebProxyResponse | - |
NiftyCreateWebProxyレスポンス |
␣requestId | string |
リクエスト識別子 |
␣webProxy | - |
Webプロキシ情報 |
␣␣routerId | string |
ルーターユニークID |
␣␣routerName | string |
ルーター名 |
␣␣listenInterface | - |
Webプロキシの受け側情報 |
␣␣␣networkId | string |
Webプロキシの受け側ネットワークID |
␣␣␣networkName | string |
Webプロキシの受け側ネットワーク名 |
␣␣listenPort | string |
Webプロキシのポート |
␣␣bypassInterface | - |
Webプロキシの迂回先情報 |
␣␣␣networkId | string |
Webプロキシの迂回先ネットワークID |
␣␣␣networkName | string |
Webプロキシの迂回先ネットワーク名 |
␣␣option | - |
オプション情報 |
␣␣␣nameServer | string |
DNSサーバのアドレス(IPv4) |
␣␣description | string |
メモ(CDATA付き) |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyCreateWebProxy
&RouterId=rt-8db04f81
&ListenInterface.NetworkId=net-54da5af8
&ListenPort=140
&BypassInterface.NetworkId=net-8fa5f644
&Option.NameServer=11.11.11.11
&CommonParams
応答サンプル
<NiftyCreateWebProxyResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<webProxy>
<routerId>rt-8db04f81</routerId>
<routerName>router1</routerName>
<listenInterface>
<networkId>net-54da5af8</networkId>
<networkName>network001</networkName>
</listenInterface>
<listenPort>140</listenPort>
<bypassInterface>
<networkId>net-8fa5f644</networkId>
<networkName>network002</networkName>
</bypassInterface>
<option>
<nameServer>11.11.11.11</nameServer>
</option>
<description><![CDATA[memo]]></description>
</webProxy>
</NiftyCreateWebProxyResponse>