本文へジャンプします。

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

CreateLoadBalancer

処理概要

ロードバランサーの定義を作成します。1回のリクエストで、1つのポート定義を作成できます。
すでに存在するロードバランサー名を指定した、存在するポート番号を指定した場合は、エラーが返されます。

ロードバランサーの定義の作成に成功した場合は、以下のAPIを実行する必要があります

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

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
LoadBalancerName ロードバランサー名
Type : String
使用可能文字 : 半角英数字( 15文字まで)
lb0001
Listeners.member.n. Protocol プロトコル
Type : String
値 : HTTP | HTTPS | FTP | 空(カスタム)
※LoadBalancerPort  の値によって設定値と異なる場合があります(後述)

(LoadBalancerPortといずれか)
HTTP
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
   
AvailabilityZones .member.n ゾーン情報
Type : String
Default : ニフティクラウドが決定
   
NetworkVolume 最大ネットワーク流量
Type : Integer
単位 : Mbps
値 : 10,20,30,40,100,200,300,400,500,600,700,800,900,1000,1100,1200,1300,1400,1500,1600,1700,1800,1900,2000
Default : 10
  10
IpVersion グローバルIPアドレスのバージョン
Type : String
値 : v4 (IPv4) |v6 (IPv6) | 空 (IPv4)
Default : v4
   
AccountingType 利用料金タイプ
Type : String
値 : 1(月額課金) | 2(従量課金)
Default : 1
   
  • ※Protocol・LoadBalancerPortの関連性は、以下を参考にしてください。
Listerners   設定される値
Protocol LoadBalancerPort InstancePort   Protocol LoadBalancerPort InstancePort
HTTP     HTTP 80 80
HTTPS     HTTPS 443 443
FTP     FTP 21 21
HTTP 70   カスタム 70 70
HTTPS 80   HTTP 80 80
カスタム 80   HTTP 80 80

応答フィールド

フィールド(項目) 説明 サンプル値
CreateLoadBalancer
Response
CreateLoadBalancer レスポンス
Type : CreateLoadBalancerResponse
Ancestor : なし
Children : CreateLoadBalancerResult, ResponseMetadata
 
CreateLoadBalancerResult ロードバランサーの情報
Type : CreateLoadBalancerResult
Ancestor : CreateLoadBalancerResponse
Children : DNSName
 
DNSName グローバルIPアドレス
Type : xsd:string
Ancestor : CreateLoadBalancerResult
Children : なし
111.171.200.1
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : CreateLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=CreateLoadBalancer&LoadBalancerName=lb0001
&Listeners.member.1.Protocol=http&NetworkVolume=10&AccountingType=1&CommonParams

応答サンプル

<CreateLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
<CreateLoadBalancerResult>
<DNSName>111.171.200.1</DNSName>
</CreateLoadBalancerResult>
<ResponseMetadata>
<RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
</ResponseMetadata>
</CreateLoadBalancerResponse>

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

APIメニュー

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

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