本文へジャンプします。

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

UpdateLoadBalancerOption

処理概要

指定したロードバランサーのオプション設定を更新します。

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

各オプションの利用設定がtrueの場合は有効、falseの場合は無効へ更新します。

Sorryページオプションを有効にするためには指定するロードバランサーの待ち受けポートが80番である必要があります。

指定するパラメーター

パラメーター 説明 必須 サンプル値
LoadBalancerName 変更対象のロードバランサー名
Type : String
lb0001
LoadBalancerPort 変更対象の待ち受けポート
Type : Integer
80
InstancePort 変更対象の宛先ポート
Type : Integer
80
SessionStickinessPolicyUpdate.Enable セッション固定オプション利用設定
Type : Boolean
  true
SessionStickinessPolicyUpdate.ExpirationPeriod セッション保持時間
単位 : 分
値 : 3-60
Type : Integer

(セッション固定オプションが有効の場合)
10
SorryPageUpdate.Enable Sorryページオプション利用設定
Type : Boolean
  true
SorryPageUpdate.StatusCode レスポンスコード
値 : 200 | 503
Type : Integer

(Sorryページオプションが有効の場合)
200

応答フィールド

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

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=UpdateLoadBalancerOption&LoadBalancerName=lb0001&LoadBalancerPort=80&InstancePort=80&SessionStickinessPolicyUpdate.Enable=true&SessionStickinessPolicyUpdate.ExpirationPeriod=10&SorryPageUpdate.Enable=true&SorryPageUpdate.StatusCode=200&CommonParams

応答サンプル

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

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

APIメニュー

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

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