本文へジャンプします。

ニフクラ APIリファレンス

NiftyUpdateAutoScalingGroup

処理概要

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
AutoScalingGroupName 更新対象オートスケール名
Type : String
使用可能な文字 : 半角英数字(1~15文字)
auto001
AutoScalingGroupNameUpdate 更新後オートスケール名
Type : String
使用可能な文字 : 半角英数字(1~15文字)
  updateauto001
Description メモ
Type : String
   
ImageId イメージID
Type : String
値 : スタンダードイメージ識別子 半角数字1〜2文字以内
カスタマイズイメージ識別子 半角数字1〜15文字以内
  2
InstanceType サーバータイプ
Type : String
値: e-mini | mini | e-small | small | e-small2 | small2 | e-small4 | small4 | e-small8 | small8 | e-medium | medium | e-medium4 | medium4 | e-medium8 | medium8 | e-medium16 | medium16 | medium24 | e-large | large | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96
Default : mini
  large
SecurityGroup.n ファイアウォールグループ名
Type : String
使用可能な文字 : 半角英数字(1~15文字)
  fw002
ScalingTrigger.n.Resource オートスケールのトリガーにするリソース名
Type : String
値: Server-cpu | Server-memory
| Server-network | LoadBalancer-network
Server-network
ScalingTrigger.n.UpperThreshold 条件「以上」の閾値
Type : Double
値: 0-100(%の場合) | 0-1048576(Mbpsの場合)
1000
ScalingTrigger.n.BreachDuration 長さ
単位 : 秒
Type : Integer
値: 600(10分) | 1200(20分) | 1800(30分)
Default : 600(10分)
  1200
ScaleoutCondition スケールアウトの条件
Type : String
値: or | and
or
LoadBalancers.n.Name ロードバランサー名
Type : String
使用可能な文字 : 半角英数字(1~15文字)
  lb002
LoadBalancers.n.LoadBalancerPort 待ち受けポート
Type : Integer
値 : 0〜65535の数値

(LoadBalancers.n.Nameを指定する場合)
8080
LoadBalancers.n.InstancePort 宛先ポート
Type : Integer
値 : 0〜65535の数値

(LoadBalancers.n.Nameを指定する場合)
8080
MinSize サーバーの最小台数
Type : Integer
値: 1と(サーバー設定上限数−1)の間
2
MaxSize サーバーの最大台数
Type : Integer
値: MinSizeとサーバー設定上限数の間
5
InstanceLifecycleLimit 有効時間
単位 : 秒
Type : Integer
値: 1800(30分)-36000(600分) (1800刻み)
Default : 18000(300分)
  36000
Scaleout スケールアウト開始間隔
単位 : 秒
Type : Integer
値: 0(0分) | 600(10分) | 1200(20分) | 1800(30分)
Default : 0(0分)
  600
DefaultCooldown 縮退開始間隔
単位 : 秒
Type : Integer
値: 600(10分) | 1200(20分) | 1800(30分) | …10分刻み…
| 34800(580分) | 35400(590分) | 36000(600)
Default : 1800(30分)
  35400
ChangeInCapacity スケールアウト・縮退台数
Type : Integer
値: 1-5
3
ScalingSchedule.n.TimeZone.StartingTimeZone スケールアウトを有効にする時間帯(開始)
Type : String
値: 0-23
Default : 0 (0:00)
  10
ScalingSchedule.n.TimeZone.EndingTimeZone スケールアウトを有効にする時間帯(終了)
Type : String
値: StartingTimeZoneの値+1-24
Default : 24 (24:00)
  24
ScalingSchedule.n.Day.SetSunday スケールアウトを有効にする曜日(日曜日)
Type : String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  1
ScalingSchedule.n.Day.SetMonday スケールアウトを有効にする曜日(月曜日)
Type : String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  1
ScalingSchedule.n.Day.SetTuesday スケールアウトを有効にする曜日(火曜日)
Type : String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  1
ScalingSchedule.n.Day.SetWednesday スケールアウトを有効にする曜日(水曜日)
Type : String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  0
ScalingSchedule.n.Day.SetThursday スケールアウトを有効にする曜日(木曜日)
Type : String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  1
ScalingSchedule.n.Day.SetFriday スケールアウトを有効にする曜日(金曜日)
Type : String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  1
ScalingSchedule.n.Day.SetSaturday スケールアウトを有効にする曜日(土曜日)
Type: String
値: 0 (無効) | 1 (有効)
Default : 0 (無効)
  1
ScalingSchedule.n.DDay.StartingDDay スケールアウトを有効にする月内日(開始)
Type : String
値: 1-31
Default : 1
  15
ScalingSchedule.n.DDay.EndingDDay スケールアウトを有効にする月内日(終了)
Type : String
StartingDDayの値 - 31
Default : 31
  18
ScalingSchedule.n.Month.StartingMonth スケールアウトを有効にする月(開始)
Type : String
値: 1-12
Default : 1
  9
ScalingSchedule.n.Month.EndingMonth スケールアウトを有効にする月(終了)
Type : String
値: StartingMonthの値-12
Default : 12
  12

応答フィールド

フィールド 説明 サンプル値
NiftyUpdateAutoScalingGroupResponse NiftyUpdateAutoScalingGroupレスポンス
Type : NiftyUpdateAutoScalingGroupResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyUpdateAutoScalingGroupResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 処理ステータス
Type : xsd: boolean
Ancestor : NiftyUpdateAutoScalingGroupResponse
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.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://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <return>true</return>
</NiftyUpdateAutoScalingGroupResponse>

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

APIメニュー

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

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