本文へジャンプします。

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

UpdateLoadBalancer

処理概要

指定したロードバランサーの定義を変更します。

ポート定義を更新する場合は、ポート番号もあわせて指定します。

削除済みのロードバランサー名・待ち受けポートを指定した、管理外のロードバランサー名を指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
LoadBalancerName 変更対象のロードバランサー名
Type : String
lb0001
ListenerUpdate.
LoadBalancerPort
変更対象の待ち受けポート
Type : Integer

(ポート定義・ロードバランス方式を変更する場合)
80
ListenerUpdate.
InstancePort
変更対象の宛先ポート
Type : Integer

(ポート定義・ロードバランス方式を変更する場合)
80
ListenerUpdate.Listener.
Protocol
プロトコルの更新値
Type : String
値 : HTTP | HTTPS | FTP | custom(カスタム)
  • ※LoadBalancerPortの値によって設定値と異なる場合があります(後述)
    Default : 空(更新なし)
   
ListenerUpdate.Listener.
LoadBalancerPort
待ち受けポートの更新値
Type : Integer

Default : 空(更新なし)
   
ListenerUpdate.Listener.
InstancePort
宛先ポートの更新値
Type : Integer
Default : 空(更新なし)
   
ListenerUpdate.Listener.
BalancingType
ロードバランス方式の更新値
Type : String
値 : 1 (Round-Robin) | 2 (Least-Connection)
Default : 空(更新なし)
  2
NetworkVolumeUpdate 最大ネットワーク流量の更新値
Type : Integer
単位 : Mbps
値 : 10,20,30,40,100,200,300,400,1000,1500,2000
Default : 空(更新なし)
  20
AccountingTypeUpdate 利用料金タイプ
Type : String
値 : 1(月額課金) | 2(従量課金)
Default : 空(更新なし)
   
  • ※Protocol・LoadBalancerPortの関連性は、以下を参考にしてください。
Listerners   設定される値
Protocol LoadBalancerPort InstancePort   Protocol LoadBalancerPort InstancePort
HTTP     HTTP 80 変更なし
  443   HTTPS 443 変更なし
    70 変更なし 変更なし 70
HTTP 443   HTTPS 443 変更なし
HTTPS   443 HTTP 80 443
  80 443 HTTP 80 443

応答フィールド

フィールド(項目) 説明 サンプル値
UpdateLoadBalancerResponse UpdateLoadBalancer レスポンス
Type : UpdateLoadBalancerResponse
Ancestor : なし
Children : ResponseMetadata
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : UpdateLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=UpdateLoadBalancer&LoadBalancerName=lb0001
&ListenerUpdate.LoadBalancerPort=80&ListenerUpdate.InstancePort=80
&ListenerUpdate.Listener.BalancingType=2&NetworkVolumeUpdate=20&AccountingTypeUpdate=1&CommonParams

応答サンプル

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

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

APIメニュー

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

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