本文へジャンプします。

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

SetFilterForLoadBalancer

処理概要

指定したロードバランサーにアクセスフィルターを設定します。

ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
LoadBalancerName 対象のロードバランサー名
Type : String
lb0001
LoadBalancerPort 対象の待ち受けポート
Type : Integer
80
InstancePort 対象の宛先ポート
Type : Integer
80
IPAddresses.member.n.
IPAddress
アクセス元IPアドレス
Type : String
値 : 特定のIPアドレス(IPv4/IPv6) | 空(すべて)
Default : 空
  111.111.111.111
IPAddresses.member.n.
AddOnFilter
追加フラグ
Type : Boolean
値 : true(IPアドレスを追加) | false,空(IPアドレスを削除)
Default : true
   
FilterType 指定したアクセス元IPアドレスへの対処
Type : xsd:string
値 : 1(許可する) | 2(拒否する)
Default : 1
   

応答フィールド

フィールド(項目) 説明 サンプル値
SetFilterForLoadBalancerResponse SetFilterForLoadBalancer レスポンス
Type : SetFilterForLoadBalancerResponse
Ancestor : なし
Children : SetFilterForLoadBalancerResult, ResponseMetadata
 
SetFilterForLoadBalancerResult 処理結果の情報セット
Type : SetFilterForLoadBalancerResult
Ancestor : SetFilterForLoadBalancerResponse
Children : Filter
 
Filter フィルター情報
Type : Filter
Ancestor : SetFilterForLoadBalancerResult
Children : FilterType, IPAddresses
 
FilterType 指定したアクセス元IPアドレスへの対処
Type : xsd:string
値 : 1(許可する) | 2(拒否する)
Ancestor : Filter
Children : なし
1
IPAddresses フィルター対象のアクセス元IPアドレスの情報セット
Type : FilterIPAddresses
Ancestor : Filter
Children : member
 
member フィルター対象のアクセス元IPアドレス
Type : FilterIPAddress
Ancestor : IPAddresses
Children : IPAddress
 
IPAddress アクセス元IPアドレス
Type : xsd:string
値 : *.*.*.*(すべてのIPアドレス) | 特定のIPアドレス(IPv4/IPv6)
Ancestor : member
Children : なし
111.111.111.111
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : SetFilterForLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=SetFilterForLoadBalancer&LoadBalancerName=lb0001
&LoadBalancerPort=80&InstancePort=80&IPAddresses.member.1.IPAddress=111.111.111.111
&CommonParams

応答サンプル

<SetFilterForLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
  <SetFilterForLoadBalancerResult>
    <Filter>
      <FilterType>1</FilterType>
      <IPAddresses>
        <member>
          <IPAddress>111.111.111.111</IPAddress>
        </member>
      </IPAddresses>
    </Filter>
  </SetFilterForLoadBalancerResult>
 <ResponseMetadata>
  <RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
 </ResponseMetadata>
</SetFilterForLoadBalancerResponse>

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

APIメニュー

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

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