本文へジャンプします。

ニフクラ ユーザーガイド

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 string ルーターユニークID
RouterName.n string ルーター名
Filter.n.Name 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 string 絞り込み条件の値

応答フィールド

フィールド (項目) 説明
NiftyDescribeWebProxiesResponse - NiftyDescribeWebProxiesレスポンス
Ancestor: なし
Children: requestId | webProxy
requestId string リクエスト識別子
Ancestor: NiftyDescribeWebProxiesResponse
Children: なし
webProxy - Webプロキシ情報セット
Ancestor: NiftyDescribeWebProxiesResponse
Children: item
item - Webプロキシ情報
Ancestor: webProxy
Children: routerId | routerName | listenInterface | listenPort | bypassInterface | option | description
routerId string ルーターユニークID
Ancestor: item
Children: なし
routerName string ルーター名
Ancestor: item
Children: なし
listenInterface - Webプロキシの受け側情報
Ancestor: item
Children: networkId | networkName
networkId string Webプロキシの受け側ネットワークID
Ancestor: listenInterface
Children: なし
networkName string Webプロキシの受け側ネットワーク名
Ancestor: listenInterface
Children: なし
listenPort string Webプロキシのポート
Ancestor: item
Children: なし
bypassInterface - Webプロキシの迂回先情報
Ancestor: item
Children: networkId | networkName
networkId string Webプロキシの迂回先ネットワークID
Ancestor: bypassInterface
Children: なし
networkName string Webプロキシの迂回先ネットワーク名
Ancestor: bypassInterface
Children: なし
option - オプション情報
Ancestor: item
Children: nameServer
nameServer string DNSサーバのアドレス(IPv4)
Ancestor: option
Children: なし
description string メモ(CDATA付き)
Ancestor: item
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyDescribeWebProxies
  &RouterId.1=rt-8db04f81
  &CommonParams

  

応答サンプル

    <NiftyDescribeWebProxiesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <webProxy>
    <item>
      <routerId>rt-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><![CDATA[memo]]></description>
    </item>
  </webProxy>
</NiftyDescribeWebProxiesResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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