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

NiftyUpdateAutoScalingGroup

処理概要

指定したオートスケールの定義を変更します。
オートスケールを指定するためには、オートスケール名が必要です。
既存のオートスケール定義情報に対し、指定された値でオートスケール定義が更新されるため、更新しない値も設定する必要があります。ただしイメージIDは例外的に省略可能とし、省略時は変更しない動作となります。
イメージを変更する場合、増設ディスク付きのイメージは使用できません。また、変更前のイメージと異なるゾーンのイメージも使用できません。

指定するパラメーター

パラメーター	型	説明	必須
AutoScalingGroupName	string	更新対象オートスケール名 使用可能文字: 半角英数字(1～15文字)	○
AutoScalingGroupNameUpdate	string	更新後オートスケール名 使用可能文字: 半角英数字(1～15文字)
Description	string	メモ
ImageId	string	イメージID 使用可能文字: スタンダードイメージ識別子　半角数字1〜4文字以内、カスタマイズイメージ識別子　半角数字1〜15文字以内
InstanceType	string	サーバータイプ 値: e-mini | mini | c-small | e-small | small | c-small2 | e-small2 | small2 | c-small4 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | c-medium | e-medium | medium | c-medium4 | e-medium4 | medium4 | c-medium8 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | c-large | e-large | large | c-large8 | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large8 | extra-large8 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-extra-large48 | extra-large48 | e-double-large16 | double-large16 | e-double-large24 | double-large24 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96 | triple-large32 | triple-large48 | triple-large64 | triple-large96 | triple-large128 | quad-large64 | quad-large96 | quad-large128 | septa-large128 Default: mini
SecurityGroup.n	string	ファイアウォールグループ名 使用可能文字: 半角英数字(1～15文字)
ScalingTrigger.n.Resource	string	オートスケールのトリガーにするリソース名 値: Server-cpu | Server-memory | Server-network | LoadBalancer-network	○
ScalingTrigger.n.UpperThreshold	double	条件「以上」の閾値 使用可能文字: %の場合　0-100、Mbpsの場合　0-1048576	○
ScalingTrigger.n.BreachDuration	integer	長さ 単位: 秒 値: 600 (10分) | 1200 (20分) | 1800 (30分) Default: 600 (10分)
ScaleoutCondition	string	スケールアウトの条件 値: or | and	○
LoadBalancers.n.Name	string	ロードバランサー名 使用可能文字: 半角英数字(1～15文字)
LoadBalancers.n.LoadBalancerPort	integer	待ち受けポート 使用可能文字: 0〜65535の数値	○ (LoadBalancers.n.Nameを指定する場合)
LoadBalancers.n.InstancePort	integer	宛先ポート 使用可能文字: 0〜65535の数値	○ (LoadBalancers.n.Nameを指定する場合)
MinSize	integer	サーバーの最小台数 使用可能文字: 1と(サーバー設定上限数−１)の間	○
MaxSize	integer	サーバーの最大台数 使用可能文字: MinSizeとサーバー設定上限数の間	○
InstanceLifecycleLimit	integer	有効時間 単位: 秒 Default: 18000 (300分) 使用可能文字: 1800(30分)-36000(600分) (1800刻み)
Scaleout	integer	スケールアウト開始間隔 単位: 秒 値: 0 (0分) | 600 (10分) | 1200 (20分) | 1800 (30分) Default: 0 (0分)
DefaultCooldown	integer	縮退開始間隔 単位: 秒 Default: 1800 (30分) 使用可能文字: 600 (10分)-36000(600分) (600刻み)
ChangeInCapacity	integer	スケールアウト・縮退台数 値: 1 | 2 | 3 | 4 | 5	○
ScalingSchedule.n.TimeZone.StartingTimeZone	string	スケールアウトを有効にする時間帯（開始） Default: 0 (0:00) 使用可能文字: 0-23
ScalingSchedule.n.TimeZone.EndingTimeZone	string	スケールアウトを有効にする時間帯（終了） Default: 24 (1440) 使用可能文字: StartingTimeZoneの値＋1-24
ScalingSchedule.n.Day.SetSunday	string	スケールアウトを有効にする曜日（日曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.Day.SetMonday	string	スケールアウトを有効にする曜日（月曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.Day.SetTuesday	string	スケールアウトを有効にする曜日（火曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.Day.SetWednesday	string	スケールアウトを有効にする曜日（水曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.Day.SetThursday	string	スケールアウトを有効にする曜日（木曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.Day.SetFriday	string	スケールアウトを有効にする曜日（金曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.Day.SetSaturday	string	スケールアウトを有効にする曜日（土曜日） 値: 0 (無効) | 1 (有効) Default: 0 (無効)
ScalingSchedule.n.DDay.StartingDDay	string	スケールアウトを有効にする月内日（開始） Default: 1 使用可能文字: 1-31
ScalingSchedule.n.DDay.EndingDDay	string	スケールアウトを有効にする月内日（終了） Default: 31
ScalingSchedule.n.Month.StartingMonth	string	スケールアウトを有効にする月（開始） Default: 1
ScalingSchedule.n.Month.EndingMonth	string	スケールアウトを有効にする月（終了） Default: 12 使用可能文字: StartingMonthの値-12

応答フィールド

フィールド (項目)	型	説明
NiftyUpdateAutoScalingGroupResponse	-	NiftyUpdateAutoScalingGroupレスポンス Ancestor: なし Children: requestId | return
requestId	string	リクエスト識別子 Ancestor: NiftyUpdateAutoScalingGroupResponse Children: なし
return	boolean	処理ステータス 値: true(成功) Ancestor: NiftyUpdateAutoScalingGroupResponse Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyUpdateAutoScalingGroup
  &AutoScalingGroupName=autoscale001
  &ImageId=cent64pImage
  &ScalingTrigger.1.Resource=Server-cpu
  &ScalingTrigger.1.UpperThreshold=50
  &ScalingTrigger.1.BreachDuration=600
  &ScaleoutCondition=or
  &MinSize=2
  &MaxSize=5
  &ChangeInCapacity=2
  &CommonParams

  

応答サンプル

    <NiftyUpdateAutoScalingGroupResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <return>true</return>
</NiftyUpdateAutoScalingGroupResponse>