本文へジャンプします。

ニフクラ APIリファレンス

NiftyModifyElasticLoadBalancerAttributes

処理概要

指定したマルチロードバランサーの詳細情報を更新します。1回のリクエストで、1つのマルチロードバランサーの情報を更新できます。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。削除済みのマルチロードバランサーを指定した、管理外のマルチロードバランサーを指定したなど、無効なマルチロードバランサーを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancerId 対象のマルチロードバランサーユニークID
Type : String

(マルチロードバランサー名といずれか)
elb-8db04f81
ElasticLoadBalancerName 対象のマルチロードバランサー名
Type : String
使用可能文字 : 半角英数字(15文字)

(マルチロードバランサーユニークIDといずれか)
 
Protocol プロトコル
Type : String
値 : TCP | UDP | HTTP | HTTPS
 
ElasticLoadBalancerPort 待ち受けポート
Type : Integer
値 : 1〜65535の数値
 
InstancePort 宛先ポート
Type : Integer
値 : 1〜65535の数値
 
LoadBalancerAttributes.Session.StickinessPolicy.Enable セッション固定オプション利用設定
Type : Boolean
Default : false (無効)
   
LoadBalancerAttributes.Session.StickinessPolicy.Method セッション固定方法
Type : String
Valid values : 1 (ソースIPアドレス) | 2 (Cookie)

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

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

(Listeners.member.n.SorryPage.Enableがtrueの場合)
 
LoadBalancerAttributes.AdditionalAttributes.member.n.Key 更新対象の項目名
Type : String
値 : protocol(プロトコル) | elasticLoadBalancerPort(待ち受けポート) | instancePort(宛先ポート) | description(メモ) | balancingType(バランス方式) | sslCertificateId(SSL証明書の発行識別子)
  1. 更新対象に指定されたprotocolが「HTTPS」の場合、sslCertificateIdは必須
  2. 更新対象に指定されたprotocolが「HTTPS」以外の場合、sslCertificateIdは指定不可
   
LoadBalancerAttributes.AdditionalAttributes.member.n.Value 更新値
Type : String
   

応答フィールド

フィールド 説明 サンプル値
NiftyModifyElasticLoadBalancerAttributesResponse NiftyModifyElasticLoadBalancerAttributesレスポンス
Type : NiftyModifyElasticLoadBalancerAttributesResponse
Ancestor :なし
Children : ResponseMetadata
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyModifyElasticLoadBalancerAttributesResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyModifyElasticLoadBalancerAttributes&ElasticLoadBalancerName=elb01&Protocol=TCP&ElasticLoadBalancerPort=80&InstancePort=80&LoadBalancerAttributes.Session.StickinessPolicy.Enable=true&LoadBalancerAttributes.Session.StickinessPolicy.Method=1&LoadBalancerAttributes.Session.StickinessPolicy.ExpirationPeriod=30&LoadBalancerAttributes.SorryPage.Enable=true&LoadBalancerAttributes.SorryPage.RedirectUrl=http://www.xxx.com/&LoadBalancerAttributes.AdditionalAttributes.member.1.Key=protocol&LoadBalancerAttributes.AdditionalAttributes.member.1.Value=TCP&CommonParams

応答サンプル

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

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

APIメニュー

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

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