本文へジャンプします。

ニフティクラウド APIリファレンス

NiftyDescribeWebProxies

処理概要

ルーターに設定されているWebプロキシの設定情報を取得します。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字(「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索)となります。

曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。

  • router-name
  • listen-network-name
  • listen-port
  • proxy-bypass-network-name
  • option-name-server

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouterId.n ルーターユニークID
Type : String
   
RouterName.n ルーター名
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : router-id(ルーターユニークID) | router-name(ルーター名) | listen-network-id(受け側ネットワークID) | listen-network-name(受け側ネットワーク名) | listen-port(Webプロキシのポート) | proxy-bypass-network-id(迂回先ネットワークID) | proxy-bypass-network-name(迂回先ネットワーク名) | option-name-server(DNSサーバのアドレス(IPv4)
 
Filter.n.Value.m 絞り込み条件の値
Type : String
   

応答フィールド

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

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyDescribeWebProxies&RouterId.1=rt-8db04f81&Filter.1.Name=listen-network-id&Filter.1.Value.1=10.*&CommonParams

応答サンプル

<NiftyDescribeWebProxiesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <webProxy>
  <item>
   <routerId>nrt-8db04f81</routerId>
   <routerName>router1</routerName>
   <listenInterface>
    <networkId>net-0xej1djx</networkId>
    <networkName>network001</networkName>
   </listenInterface>
   <listenPort>140</listenPort>
   <bypassInterface>
    <networkId>net-0k87jhm</networkId>
    <networkName>network002</networkName>
   </bypassInterface>
   <option>
    <nameServer>11.11.11.11</nameServer>
   </option>
   <description>memo</description>
  </item>
 </webProxy>
</NiftyDescribeWebProxiesResponse>

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

APIメニュー

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

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