本文へジャンプします。

ニフクラ APIリファレンス

NiftyCreateWebProxy

処理概要

指定したルーターに対してWebプロキシを新規作成します。
受け側/迂回先ネットワークは、ルーターと紐付きのあるネットワークを指定する必要があります。

ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouterId ルーターユニークID
Type : String

(ルーター名といずれか)
 
RouterName ルーター名
Type : String

(ルーター名といずれか)
 
ListenInterface.NetworkId Webプロキシの受け側ネットワークID
Type : String

(Webプロキシの受け側ネットワーク名といずれか)
 
ListenInterface.NetworkName Webプロキシの受け側ネットワーク名
Type : String

(Webプロキシの受け側ネットワークIDといずれか)
 
ListenPort Webプロキシのポート
Type : String
 
BypassInterface.NetworkId Webプロキシの迂回先ネットワークID
Type : String
   
BypassInterface.NetworkName Webプロキシの迂回先ネットワーク名
Type : String
   
Option.NameServer DNSサーバのアドレス(IPv4)
Type : String
Default: ニフクラが決定
   
Description メモ
Type : String
   
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type:bBoolean
Default:false

(バックアップを保持する場合のみ)
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyCreateWebProxyResponse NiftyCreateWebProxyレスポンス
Type : NiftyCreateWebProxyResponseType
Ancestor : なし
Children : requestId, webProxy
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyCreateWebProxyResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
webProxy Webプロキシ情報
Type : WebProxyType
Ancestor : NiftyCreateWebProxyResponse
Children : routerId,routerName,listenInterface,listenPort,bypassInterface,option ,description
 
routerId ルーターユニークID
Type : xsd:string
Ancestor : webProxy
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : webProxy
Children : なし
 
listenInterface Webプロキシの受け側情報
Type : NetworkInterfaceType
Ancestor : webProxy
Children : networkId、networkName
 
networkId Webプロキシの受け側ネットワークID
Type : xsd:string
Ancestor : listenInterface
Children : なし
 
networkName Webプロキシの受け側ネットワーク名
Type : xsd:string
Ancestor : listenInterface
Children : なし
 
listenPort Webプロキシのポート
Type : xsd: String
Ancestor : webProxy
Children : なし
 
bypassInterface Webプロキシの迂回先情報
Type : NetworkInterfaceType
Ancestor : webProxy
Children : networkId、networkName
 
networkId Webプロキシの迂回先ネットワークID
Type : xsd:string
Ancestor : bypassInterface
Children : なし
 
networkName Webプロキシの迂回先ネットワーク名
Type : xsd:string
Ancestor : bypassInterface
Children : なし
 
option オプション情報
Type : WebProxyOptionType
Ancestor : webProxy
Children : nameServer
 
nameServer DNSサーバのアドレス(IPv4)
Type : xsd:string
Ancestor : option
Children : なし
 
description メモ
Type : xsd:string
Ancestor : webProxy
Children : なし
 

リクエストサンプル

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://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <webProxy>
  <routerId>nrt-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>memo</description>
 </webProxy>
</NiftyCreateWebProxyResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上