本文へジャンプします。

ニフクラ APIリファレンス

NiftyCreateElasticLoadBalancer

処理概要

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

1回のリクエストで、1つのポート定義を作成できます。
すでに存在するマルチロードバランサー名を指定した、存在するポート番号を指定した場合は、エラーが返されます。
マルチロードバランサーの作成に成功した場合は、以下のAPIを実行する必要があります。

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancerName マルチロードバランサー名
Type : String
使用可能文字:半角英数字(15文字)
  elb-8db04f81
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.BalancingType ロードバランス方式
Type : String
値 : 1 (Round-Robin) | 2 (Least-Connection)
Default : 1
   
Listeners.member.n.Description マルチロードバランサーのメモ情報
Type : String
Default : None
   
Listeners.member.n.Instances.member.m.InstanceUniqueId サーバーユニークID
Type : String
  i-a1b2c3d4
Listeners.member.n.Instances.member.m.InstanceId サーバー名
Type : String
使用可能文字 : 半角英数字(15文字)
   
Listeners.member.n.HealthCheck.Target ヘルスチェック プロトコル(TCP/HTTP/HTTPS指定の場合 「:宛先ポート」)
Type : String
値 : TCP:宛先ポート(数字 1-65535) | HTTP:宛先ポート(数字 1-65535) | HTTPS:宛先ポート(数字 1-65535) | ICMP
   
Listeners.member.n.HealthCheck.Interval ヘルスチェック間隔(秒)
Type : Integer
単位 : 秒
値 : 5- 300
Default : 5

(HealthCheck.Targetが設定されている場合)
 
Listeners.member.n.HealthCheck.UnhealthyThreshold ヘルスチェック回数閾値
Type : Integer
値 : 1-10
Default : 1

(HealthCheck.Targetが設定されている場合)
 
Listeners.member.n.HealthCheck.Path ヘルスチェックパス
Type : String
使用可能文字 : 「!`$#\";」を除く半角英数記号(255文字)
  1. 指定されたListeners.member.n.HealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効
  2. 先頭が”/”で始まっていること
   
Listeners.member.n.HealthCheck.Expectation.member.m.HttpCode ヘルスチェック期待値
Type : Integer
値 : 200-499
  1. 指定されたListeners.member.n.HealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効
  2. HTTPステータスコードを指定
  3. 最大10個まで設定可能
   
Listeners.member.n.SSLCertificateId SSL証明書の発行識別子
Type : String
  1. 指定されたListeners.member.n.Protocolが「HTTPS」の場合は、必須
  2. 指定されたListeners.member.n.Protocolが「HTTPS」以外の場合、指定不可

(Listeners.member.n.ProtocolがHTTPSの場合のみ)
 
Listeners.member.n.Session.StickinessPolicy.Enable セッション固定オプション利用設定
Type : Boolean
Default : false (無効)
   
Listeners.member.n.Session.StickinessPolicy.Method セッション固定方法
Type : String
Valid values : 1(ソースIPアドレス) | 2 (Cookie)

(Listeners.member.n.Session.StickinessPolicy.Enableがtrueの場合)
 
Listeners.member.n.Session.StickinessPolicy.ExpirationPeriod セッション保持時間
Type : Integer
単位 : 分
値 : 3-60

(Listeners.member.n.Session.StickinessPolicy.Enableがtrueの場合)
 
Listeners.member.n.SorryPage.Enable Sorryページオプション利用設定
Type : Boolean
Default : false (無効)
   
Listeners.member.n.SorryPage.RedirectUrl Sorryページリダイレクト先URL
Type : String

(Listeners.member.n.SorryPage.Enableがtrueの場合)
 
AvailabilityZones.member.1 ゾーン情報(複数指定は不可)
Type : String
 
NetworkVolume 最大ネットワーク流量
Type : Integer
単位 : Mbps
値 : 10 | 20 | 30 | 40 | 100 | 200 | 300 | 400 | 500
Default : 10
   
AccountingType 利用料金タイプ
Type : String
値 : 1(月額課金) | 2(従量課金)
Default : 2
   
NetworkInterface.n.NetworkId ネットワークID
Type : String
値 : net-COMMON_GLOBAL(共通グローバル) | net-COMMON_PRIVATE (共通プライベート) |プライベートLAN のネットワークID

(ネットワーク名といずれか)
 
NetworkInterface.n.NetworkName ネットワーク名
Type : String

(ネットワークIDといずれか)
 
NetworkInterface.n.IpAddress IPアドレス
Type : String
  1. 指定されたネットワークが共通グローバルの場合、指定不可
  2. 指定されたネットワークが共通プライベートの場合、指定不可
  3. 指定されたネットワークがプライベートLANの場合、対象プライベートLANのネットワーク帯の範囲で、IPv4形式でIPアドレスの指定可能
  4. 指定されたネットワークがプライベートLANの場合、IPv4形式以外、また指定がない場合にエラー

(NetworkInterface.n.NetworkIdがプライベートLAN、またはNetworkInterface.n.NetworkNameが指定された場合)
 
NetworkInterface.n.IsVipNetwork VIPネットワークフラグ(待ち受けポートが設定されるネットワーク)
Type : Boolean
値 : true(設定する) | false(設定しない)
Default : true
   

応答フィールド

フィールド 説明 サンプル値
NiftyCreateElasticLoadBalancerResponse NiftyCreateElasticLoadBalancerレスポンス
Type : NiftyCreateElasticLoadBalancerResponse
Ancestor :なし
Children : NiftyCreateElasticLoadBalancerResult, ResponseMetadata
 
NiftyCreateElasticLoadBalancerResult マルチロードバランサーの情報
Type : NiftyCreateElasticLoadBalancerResult
Ancestor : NiftyCreateElasticLoadBalancerResponse
Children : DNSName
 
DNSName VIPネットワーク IPアドレス(宛先ポートが設定されているネットワークに設定されているIPアドレス)
Type : NiftyCreateElasticLoadBalancerResult
Ancestor : NiftyCreateElasticLoadBalancerResult
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyCreateElasticLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://cp.cloud.nifty.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.NetworkId=net-COMMON_GLOBAL&NetworkInterface.1.IsVipNetwork=true

応答サンプル

<NiftyCreateElasticLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
  <NiftyCreateElasticLoadBalancerResult>
    <DNSName>124.25.72.33</DNSName>
  </NiftyCreateElasticLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyCreateElasticLoadBalancerResponse>

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

APIメニュー

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

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