本文へジャンプします。

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

RegisterPortWithLoadBalancer

処理概要

指定したロードバランサーにポートを追加します。

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

ポートの追加に成功した場合は、以下のAPIを実行する必要があります。

  • API「RegisterInstancesWithLoadBalancer」(サーバー設定)
  • API「ConfigureHealthCheck」(ヘルスチェック設定)

フィルターの設定は、「すべてのアクセスを許可する」になっています。変更を行う場合は以下のAPIを実行する必要があります。

  • API「SetFilterForLoadBalancer」(フィルター設定)

指定するパラメーター

パラメーター 説明 必須 サンプル値
LoadBalancerName 対象のロードバランサー名
Type : String
lb0001
Listeners.member.n.
Protocol
追加するポートのプロトコル
Type : String
値 : HTTP | HTTPS | FTP | 空(カスタム)
※LoadBalancerPort  の値によって設定値と異なる場合があります(後述)

(LoadBalancerPortといずれか)
HTTPS
Listeners.member.n.
LoadBalancerPort
追加する待ち受けポート
Type : Integer
Default : Protocolでの指定値による
80(Protocol=HTTP) | 443(Protocol=HTTPS) | 21(Protocol=FTP)

(Protocolといずれか)
 
Listeners.member.n.
InstancePort
追加する宛先ポート
Type : Integer
Default : Protocolでの指定値による
80(Protocol=HTTP) | 443(Protocol=HTTPS) | 21(Protocol=FTP)
   
Listeners.member.n.
BalancingType
追加するポートのロードバランス方式
Type : String
値 : 1 (Round-Robin) | 2 (Least-Connection)
Default : 1
  2
  • ※Protocol・LoadBalancerPortの関連性は、以下を参考にしてください。
Listerners   設定される値
Protocol LoadBalancerPort InstancePort   Protocol LoadBalancerPort InstancePort
HTTP     HTTP 80 80
HTTPS     HTTPS 443 443
FTP     FTP 21 21
HTTP 70   カスタム 70 80
HTTPS 80   HTTP 80 80
カスタム 80   HTTP 80 80

応答フィールド

フィールド(項目) 説明 サンプル値
RegisterPort
WithLoadBalancerResponse
RegisterPortWithLoadBalancer レスポンス
Type : RegisterPortWithLoadBalancerResponse
Ancestor : なし
Children : RegisterPortWithLoadBalancerResult, ResponseMetadata
 
RegisterPort
WithLoadBalancerResult
処理結果の情報セット
Type : RegisterPortWithLoadBalancerResult
Ancestor : RegisterPortWithLoadBalancerResponse
Children : Listeners
 
Listeners 追加に成功したポートの情報セット
Type : Listeners
Ancestor : RegisterPortWithLoadBalancerResult
Children : member
 
member 追加に成功したポートの情報
Type : Listener
Ancestor : Listeners
Children : Protocol, LoadBalancerPort, InstancePort, BalancingType
 
Protocol プロトコル
Type : xsd: string
Ancestor : member
Children : なし
 
LoadBalancerPort 待ち受けポート
Type : xsd:integer
Ancestor : member
Children : なし
 
InstancePort 宛先ポート
Type : xsd:integer
Ancestor : member
Children : なし
 
BalancingType ロードバランス方式
Type : xsd:string
Ancestor : member
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : RegisterPortWithLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=RegisterPortWithLoadBalancer&LoadBalancerName=lb0001&
Listeners.member.1.Protocol=HTTPS&Listeners.member.1.BalancingType=2&CommonParams 

応答サンプル

<RegisterPortWithLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
 <RegisterPortWithLoadBalancerResult>
  <Listeners>
   <member>
    <Protocol>HTTPS</Protocol>
    <LoadBalancerPort>443</LoadBalancerPort>
    <InstancePort>443</InstancePort>
    <BalancingType>2</BalancingType>
   </member>
  </Listeners>
 </RegisterPortWithLoadBalancerResult>
 <ResponseMetadata>
  <RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
 </ResponseMetadata>
</RegisterPortWithLoadBalancerResponse>

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

APIメニュー

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

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