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

NiftyCreateElasticLoadBalancer

処理概要

マルチロードバランサーを作成します。

1回のリクエストで、1つのポート定義を作成できます。
マルチロードバランサーの作成後、サーバーを追加する場合は、以下のAPIを実行する必要があります。

• API「NiftyRegisterInstancesWithElasticLoadBalancer」（サーバー設定）

マルチロードバランサーでSSLアクセラレーター設定をする場合は、プロトコル「HTTPS」とSSL証明書の発行識別子を指定して作成してください。SSLアクセラレーター設定しない場合は、プロトコル「TCP」で必要ポートを指定して作成していただく必要があります。

ヘルスチェックの設定でヘルスチェックパス、およびヘルスチェック期待値を指定するためには、ヘルスチェックプロトコルが「HTTP」もしくは「HTTPS」である必要があります。
作成したマルチロードバランサーの内容は、API「NiftyDescribeElasticLoadBalancers」で確認できます。

指定するパラメーター

パラメーター	型	説明	必須
ElasticLoadBalancerName	string	マルチロードバランサー名 使用可能文字: 半角英数字(15文字)
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.BalancingType	integer	ロードバランス方式 値: 1 (Round-Robin) 2 (Least-Connection) Default: 1
Listeners.member.n.Description	string	マルチロードバランサーのメモ情報
Listeners.member.n.Instances.member.m.InstanceUniqueId	string	サーバーユニークID
Listeners.member.n.Instances.member.m.InstanceId	string	サーバー名 使用可能文字: 半角英数字(15文字)
Listeners.member.n.HealthCheck.Target	string	ヘルスチェック プロトコル(TCP/HTTP/HTTPS指定の場合 「:宛先ポート」) 使用可能文字: TCP:宛先ポート(数字 1-65535) | HTTP:宛先ポート(数字 1-65535) | HTTPS:宛先ポート(数字 1-65535) | ICMP
Listeners.member.n.HealthCheck.Interval	integer	ヘルスチェック間隔(秒) 単位: 秒 Default: 5 使用可能文字: 5-300	○ (HealthCheck.Targetが設定されている場合)
Listeners.member.n.HealthCheck.UnhealthyThreshold	integer	ヘルスチェック回数閾値 Default: 1 使用可能文字: 1-10	○ (HealthCheck.Targetが設定されている場合)
Listeners.member.n.HealthCheck.Path	string	ヘルスチェックパス 1.指定されたListeners.member.n.HealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効 2.先頭が”/”で始まっていること 使用可能文字: ASCII(255文字)
Listeners.member.n.HealthCheck.Expectation.member.m.HttpCode	string	ヘルスチェック期待値 1.指定されたListeners.member.n.HealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効 2.HTTPステータスコードを指定 3.最大5個まで設定可能 値: 1xx 2xx 3xx 4xx 5xx
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.Session.StickinessPolicy.Enable	boolean	セッション固定オプション利用設定 Default: false (無効)
Listeners.member.n.Session.StickinessPolicy.Method	string	セッション固定方法 値: 1 (ソースIPアドレス) 2 (Cookie)	○ (Listeners.member.n.Session.StickinessPolicy.Enableがtrueの場合)
Listeners.member.n.Session.StickinessPolicy.ExpirationPeriod	integer	セッション保持時間 1.セッション固定方法が「Cookie」かつマルチロードバランサーのversionがv2.0以降の場合、3-1440が指定可能 2.その他の場合、3-60が指定可能 単位: 分	○ (Listeners.member.n.Session.StickinessPolicy.Enableがtrueかつ、LoadBalancerAttributes.Session.StickinessPolicy.Methodが1の場合(マルチロードバランサーのversionがv1.xの場合はMethod問わず必須))
Listeners.member.n.SorryPage.Enable	boolean	Sorryページオプション利用設定 Default: false (無効)
Listeners.member.n.SorryPage.RedirectUrl	string	Sorryページリダイレクト先URL	○ (Listeners.member.n.SorryPage.Enableがtrueの場合)
AvailabilityZones.member.1	string	ゾーン情報(複数指定は不可)	○
NetworkVolume	integer	最大ネットワーク流量 Default: 10 使用可能文字: 10, 20, 30, 40, 100, 200, 300, 400, 500
AccountingType	string	利用料金タイプ 値: 1 (月額課金) 2 (従量課金) Default: 2
NetworkInterface.n.NetworkId	string	ネットワークID 使用可能文字: net-COMMON_GLOBAL(共通グローバル)、net-COMMON_PRIVATE(共通プライベート)、プライベートLAN のネットワークID	○ (ネットワーク名といずれか)
NetworkInterface.n.NetworkName	string	ネットワーク名	○ (ネットワークIDといずれか)
NetworkInterface.n.IpAddress	string	IPアドレス 1.指定されたネットワークが共通グローバルの場合、指定不可 2.指定されたネットワークが共通プライベートの場合、指定不可 3.指定されたネットワークがプライベートLANの場合、対象プライベートLANのネットワーク帯の範囲で、IPv4形式でIPアドレスの指定可能 4.指定されたネットワークがプライベートLANの場合、IPv4形式以外、また指定がない場合にエラー	○ (NetworkInterface.n.NetworkIdがプライベートLAN、またはNetworkInterface.n.NetworkNameが指定された場合)
NetworkInterface.n.SystemIpAddresses.m.SystemIpAddress	string	システムIPアドレス 1.指定されたネットワークが共通グローバルの場合、指定不可 2.指定されたネットワークが共通プライベートの場合、指定不可 3.指定されたネットワークがプライベートLANの場合、対象プライベートLANのネットワーク帯の範囲で、IPv4形式でIPアドレスを2つ指定する必要がある 4.指定されたネットワークがプライベートLANの場合、IPv4形式以外、また指定がない場合にエラー	○ (ネットワークがプライベートLANの場合)
NetworkInterface.n.IsVipNetwork	boolean	VIPネットワークフラグ(待ち受けポートが設定されるネットワーク) 値: true (設定する) false (設定しない) Default: true

応答フィールド

フィールド (項目)	型	説明
NiftyCreateElasticLoadBalancerResponse	-	NiftyCreateElasticLoadBalancerレスポンス
␣NiftyCreateElasticLoadBalancerResult	-	マルチロードバランサーの情報
␣␣DNSName	string	VIPネットワーク IPアドレス(宛先ポートが設定されているネットワークに設定されているIPアドレス)
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyCreateElasticLoadBalancer
  &ElasticLoadBalancerName=ELB1
  &Listeners.member.1.Protocol=TCP
  &Listeners.member.1.ElasticLoadBalancerPort=80
  &Listeners.member.1.InstancePort=80
  &Listeners.member.1.BalancingType=1
  &Listeners.member.1.Session.StickinessPolicy.Enable=true
  &Listeners.member.1.Session.StickinessPolicy.Method=1
  &Listeners.member.1.Session.StickinessPolicy.ExpirationPeriod=10
  &NetworkVolume=10
  &AvailabilityZones.member.1=east11
  &NetworkInterface.1.NetworkName=network
  &NetworkInterface.1.IpAddress=192.168.0.1
  &NetworkInterface.1.SystemIpAddresses.1.SystemIpAddress=192.168.0.2
  &NetworkInterface.1.SystemIpAddresses.2.SystemIpAddress=192.168.0.3
  &NetworkInterface.1.IsVipNetwork=true

  

応答サンプル

    <NiftyCreateElasticLoadBalancerResponse xmlns="https://computing.api.nifcloud.com/api/">
  <NiftyCreateElasticLoadBalancerResult>
    <DNSName>192.168.0.1</DNSName>
  </NiftyCreateElasticLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyCreateElasticLoadBalancerResponse>