本文へジャンプします。

ニフクラ APIリファレンス

NiftyRegisterPortWithElasticLoadBalancer

処理概要

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

マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。削除済みのマルチロードバランサーを指定した、管理外のマルチロードバランサーを指定したなど、無効なマルチロードバランサーを指定した場合は、エラーが返されます。
ポートの追加に成功した場合は、以下のAPI を実行する必要があります。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancerId 対象のマルチロードバランサーユニークID
Type : String

(マルチロードバランサー名といずれか)
elb-8db04f81
ElasticLoadBalancerName 対象のマルチロードバランサー名
Type : String
使用可能文字 : 半角英数字(15文字)

(マルチロードバランサーユニークIDといずれか)
 
Listeners.member.n.Protocol プロトコル
Type : String
値 : TCP | UDP | HTTP | HTTPS
 
Listeners.member.n.ElasticLoadBalancerPort 待ち受けポート
Type : Integer
値 : 1〜65535の数値
 
Listeners.member.n.InstancePort 宛先ポート
Type : Integer
値 : 1〜65535の数値
 
Listeners.member.n.SSLCertificateId SSL証明書の発行識別子
Type : Strin
  1. 指定されたListeners.member.n.Protocolが「HTTPS」の場合は、必須
  2. 指定されたListeners.member.n.Protocolが「HTTPS」以外の場合、指定不可

(Listeners.member.n.ProtocolがHTTPSの場合のみ)
 
Listeners.member.n.BalancingType ロードバランス方式
Type : String
値 : 1 (Round-Robin) | 2 (Least-Connection)
Default : 1
   
Listeners.member.n.Description マルチロードバランサーのメモ情報
Type : String
Default : None
   

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyRegisterPortWithElasticLoadBalancerResponse NiftyRegisterPortWithElasticLoadBalancerレスポンス
Type : NiftyRegisterPortWithElasticLoadBalancerResponse
Ancestor :なし
Children : NiftyRegisterPortWithElasticLoadBalancerResult,ResponseMetadata
 
NiftyRegisterPortWithElasticLoadBalancerResult 処理結果の情報セット
Type : NiftyRegisterPortWithElasticLoadBalancerResult
Ancestor : NiftyRegisterPortWithElasticLoadBalancerResponse
Children : Listeners
 
Listeners マルチロードバランサーのポート設定情報セット
Type : Listeners
Ancestor : NiftyRegisterInstancesWithElasticLoadBalancerResult
Children : member
 
member マルチロードバランサーのポート設定情報
Type : member
Ancestor : Listeners
Children : Listener
 
Listener マルチロードバランサーのポート設定情報
Type : Listener
Ancestor : member
Children : Protocol、ElasticLoadBalancerPort、InstancePort、BalancingType、Description
 
Protocol プロトコル
Type : xsd:string
値 : TCP | UDP | HTTP | HTTPS
Ancestor : Listener
Children : なし
 
ElasticLoadBalancerPort 待ち受けポート
Type : xsd:integer
値 : 1〜65535の数値
Ancestor : Listener
Children : なし
 
InstancePort 宛先ポート
Type : xsd:integer
値 : 1〜65535の数値
Ancestor : Listener
Children : なし
 
BalancingType ロードバランス方式
Type : xsd:string
値 : 1 (Round-Robin) | 2 (Least-Connection)
Ancestor : Listener
Children : なし
 
Description マルチロードバランサーのメモ情報
Type : xsd:string
Ancestor : Listener
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyRegisterPortWithElasticLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyRegisterPortWithElasticLoadBalancer&ElasticLoadBalancerName=elb01&Listeners.member.1.Protocol=TCP&Listeners.member.1.ElasticLoadBalancerPort=80&Listeners.member.1.InstancePort=80&Listeners.member.1.BalancingType=1&Listeners.member.1.Description=listener1&Listeners.member.2.Protocol=UDP&Listeners.member.2.ElasticLoadBalancerPort=443&Listeners.member.2.InstancePort=443&Listeners.member.2.BalancingType=2&Listeners.member.2.Description=listener2&CommonParams

応答サンプル

<NiftyRegisterPortWithElasticLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
  <NiftyRegisterPortWithElasticLoadBalancerResult>
    <Listeners>
      <member>
        <Protocol>TCP</Protocol>
        <ElasticLoadBalancerPort>80</ElasticLoadBalancerPort>
        <InstancePort>80</InstancePort>
        <BalancingType>1</BalancingType>
        <Description>listener1</Description>
      </member>
      <member>
        <Protocol>UDP</Protocol>
        <ElasticLoadBalancerPort>443</ElasticLoadBalancerPort>
        <InstancePort>443</InstancePort>
        <BalancingType>2</BalancingType>
        <Description>listener2</Description>
      </member>
    </Listeners>
  </NiftyRegisterPortWithElasticLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyRegisterPortWithElasticLoadBalancerResponse>

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

APIメニュー

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

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