ニフクラAPI (コンピューティング: NiftyRegisterPortWithElasticLoadBalancer)

NiftyRegisterPortWithElasticLoadBalancer

処理概要

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

マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。
ポートの追加に成功した場合は、以下のAPI を実行する必要があります。

• API「NiftyRegisterInstancesWithElasticLoadBalancer」（サーバー設定）
• API「NiftyConfigureElasticLoadBalancerHealthCheck」（ヘルスチェック設定）

指定するパラメーター

パラメーター	型	説明	必須
ElasticLoadBalancerId	string	対象のマルチロードバランサーユニークID	○ (マルチロードバランサー名といずれか)
ElasticLoadBalancerName	string	対象のマルチロードバランサー名 使用可能文字: 半角英数字(15文字)	○ (マルチロードバランサーユニークIDといずれか)
Listeners.member.n.Protocol	string	プロトコル 値: TCP | UDP | HTTP | HTTPS	○
Listeners.member.n.ElasticLoadBalancerPort	integer	待ち受けポート 使用可能文字: 1〜65535の数値	○
Listeners.member.n.InstancePort	integer	宛先ポート 使用可能文字: 1〜65535の数値	○
Listeners.member.n.SSLCertificateId	string	SSL証明書の発行識別子 1.指定されたListeners.member.n.Protocolが「HTTPS」の場合は、必須 2.指定されたListeners.member.n.Protocolが「HTTPS」以外の場合、指定不可	○ (Listeners.member.n.ProtocolがHTTPSの場合のみ)
Listeners.member.n.BalancingType	integer	ロードバランス方式 値: 1 (Round-Robin) | 2 (Least-Connection) Default: 1
Listeners.member.n.Description	string	マルチロードバランサーのメモ情報

応答フィールド

フィールド (項目)	型	説明
NiftyRegisterPortWithElasticLoadBalancerResponse	-	NiftyRegisterPortWithElasticLoadBalancerレスポンス Ancestor: なし Children: NiftyRegisterPortWithElasticLoadBalancerResult | ResponseMetadata
NiftyRegisterPortWithElasticLoadBalancerResult	-	処理結果の情報セット Ancestor: NiftyRegisterPortWithElasticLoadBalancerResponse Children: Listeners
Listeners	-	マルチロードバランサーのポート設定情報セット Ancestor: NiftyRegisterPortWithElasticLoadBalancerResult Children: member
member	-	マルチロードバランサーのポート設定情報 Ancestor: Listeners Children: Protocol | ElasticLoadBalancerPort | InstancePort | BalancingType | Description | SSLCertificateId
Protocol	string	プロトコル 値: TCP | UDP | HTTP | HTTPS Ancestor: member Children: なし
ElasticLoadBalancerPort	integer	待ち受けポート 値: 1〜65535の数値 Ancestor: member Children: なし
InstancePort	integer	宛先ポート 値: 1〜65535の数値 Ancestor: member Children: なし
BalancingType	integer	ロードバランス方式 値: 1(Round-Robin) | 2(Least-Connection) Ancestor: member Children: なし
Description	string	マルチロードバランサーのメモ情報(CDATA付) Ancestor: member Children: なし
SSLCertificateId	string	SSL証明書の発行識別子 Ancestor: member Children: なし
ResponseMetadata	-	リクエスト情報 Ancestor: NiftyRegisterPortWithElasticLoadBalancerResponse Children: RequestId
RequestId	string	リクエスト識別子 Ancestor: ResponseMetadata Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.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=HTTPS
  &Listeners.member.2.ElasticLoadBalancerPort=443
  &Listeners.member.2.InstancePort=443
  &Listeners.member.2.BalancingType=2
  &Listeners.member.2.Description=listener2
  &Listeners.member.2.SSLCertificateId=111
  &CommonParams

  

応答サンプル

    <NiftyRegisterPortWithElasticLoadBalancerResponse xmlns="https://computing.api.nifcloud.com/api/">
  <NiftyRegisterPortWithElasticLoadBalancerResult>
    <Listeners>
      <member>
        <Protocol>TCP</Protocol>
        <ElasticLoadBalancerPort>80</ElasticLoadBalancerPort>
        <InstancePort>80</InstancePort>
        <BalancingType>1</BalancingType>
        <Description><![CDATA[listener1]]></Description>
      </member>
      <member>
        <Protocol>HTTPS</Protocol>
        <ElasticLoadBalancerPort>443</ElasticLoadBalancerPort>
        <InstancePort>443</InstancePort>
        <BalancingType>2</BalancingType>
        <Description><![CDATA[listener2]]></Description>
        <SSLCertificateId>111</SSLCertificateId>
      </member>
    </Listeners>
  </NiftyRegisterPortWithElasticLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyRegisterPortWithElasticLoadBalancerResponse>