ニフクラAPI (コンピューティング: NiftyModifyElasticLoadBalancerAttributes)

NiftyModifyElasticLoadBalancerAttributes

処理概要

指定したマルチロードバランサーの詳細情報を更新します。1回のリクエストで、1つのマルチロードバランサーの情報を更新できます。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。

Sorryページオプションは、プロトコル「HTTP」または「HTTPS」の場合に利用が可能です。

指定するパラメーター

パラメーター	型	説明	必須
ElasticLoadBalancerId	string	対象のマルチロードバランサーユニークID	○ (マルチロードバランサー名といずれか)
ElasticLoadBalancerName	string	対象のマルチロードバランサー名 使用可能文字: 半角英数字(15文字)	○ (マルチロードバランサーユニークIDといずれか)
Protocol	string	プロトコル 値: TCP UDP HTTP HTTPS	○
ElasticLoadBalancerPort	integer	待ち受けポート 使用可能文字: 1〜65535の数値	○
InstancePort	integer	宛先ポート 使用可能文字: 1〜65535の数値	○
LoadBalancerAttributes.Session.StickinessPolicy.Enable	boolean	セッション固定オプション利用設定 Default: false (無効)
LoadBalancerAttributes.Session.StickinessPolicy.Method	string	セッション固定方法 値: 1 (ソースIPアドレス) 2 (Cookie)	○ (LoadBalancerAttributes.Session.StickinessPolicy.Enableがtrueの場合)
LoadBalancerAttributes.Session.StickinessPolicy.ExpirationPeriod	integer	セッション保持時間 1.セッション固定方法が「Cookie」かつマルチロードバランサーのversionがv2.0以降の場合、3-1440が指定可能 2.その他の場合、3-60が指定可能 単位: 分	○ (LoadBalancerAttributes.Session.StickinessPolicy.Enableがtrueかつ、LoadBalancerAttributes.Session.StickinessPolicy.Methodが1の場合(マルチロードバランサーのversionがv1.xの場合はMethod問わず必須))
LoadBalancerAttributes.SorryPage.Enable	boolean	Sorryページオプション利用設定 Default: false (無効)
LoadBalancerAttributes.SorryPage.RedirectUrl	string	Sorryページリダイレクト先URL	○ (LoadBalancerAttributes.SorryPage.Enableがtrueの場合)
LoadBalancerAttributes.AdditionalAttributes.member.n.Key	string	更新対象の項目名 1.更新対象に指定されたprotocolが「HTTPS」の場合、sslCertificateIdは必須 2.更新対象に指定されたprotocolが「HTTPS」以外の場合、sslCertificateIdは指定不可 値: protocol (プロトコル) elasticLoadBalancerPort (待ち受けポート) instancePort (宛先ポート) description (メモ) balancingType (バランス方式) sslCertificateId (SSL証明書の発行識別子)
LoadBalancerAttributes.AdditionalAttributes.member.n.Value	string	更新値

応答フィールド

フィールド (項目)	型	説明
NiftyModifyElasticLoadBalancerAttributesResponse	-	NiftyModifyElasticLoadBalancerAttributesレスポンス
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyModifyElasticLoadBalancerAttributes
  &ElasticLoadBalancerName=elb01
  &Protocol=HTTP
  &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=description
  &LoadBalancerAttributes.AdditionalAttributes.member.1.Value=memo
  &CommonParams

  

応答サンプル

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