Cloudn AutoScaling APIリファレンス

本マニュアルでは、 Cloudn AutoScaling のAPIご利用方法に関してご説明いたします。

右上の “索引” や、左のバーにある検索にて検索が可能です。

1. Cloudn APIについて

Cloudn では、各プロダクトごとにAPIを提供しております。
APIを使用することで、コントロールパネルを介さずにお客様のプログラムから直接リソースを操作することが可能です。

1.1. API共通情報

ご利用にあたっては下記の通りの情報/前提知識が必要となります。

API共通情報

以下、3つの情報がAPIを利用するにあたり必要となります。

  • アクセスキーID
  • 秘密鍵
  • APIエンドポイント

以下の2つを Cloudn ポータルよりログインし、入手します。

  • アクセスキーID

    • APIへのアクセスにおいて、お客様個人のIDを識別するためのキーです。
    • お客様固有のものとなります
  • 秘密鍵

    • APIへのアクセスにおいて、電子署名に利用される鍵です。
    • お客様固有のものとなります

APIエンドポイントについては、各 Cloudn サービスごとに異なります。 下記を参照してください。

API情報 ( Cloudn AutoScaling API)

アクセスキーID・秘密鍵入手方法

Cloudn ポータルへログイン

下記URLより、パスワード/IDでログインをします。

https://portal.cloudn-service.com/comgi/login

画面下部”APIアクセスキー・秘密鍵管理”をクリック

画面下部に存在する”APIアクセスキー・秘密鍵管理”をクリックします。

ポータルから秘密鍵へのリンク

Cloudn ポータル最下段、アクセスキーID・秘密鍵管理画面へのリンク

Query API->アクセスキーID・秘密鍵をコピーして利用

アクセスキーID・秘密鍵をコピーして利用します。

アクセスキーID・秘密鍵管理画面キャプチャ

アクセスキーID・秘密鍵管理画面

1.2. API情報 ( Cloudn AutoScaling API)

エンドポイント

本サービスにて提供しているAPI Server (End Point)のURIは下記となります。
リージョン URL
東日本FLAT https://as-api.jp-e1.cloudn-service.com/
西日本FLAT https://as-api.jp-w1.cloudn-service.com/
米国FLAT https://as-api.us-e1.cloudn-service.com/
東日本VPCOpenNW https://as-vpcopennw-api.jp-e1.cloudn-service.com/

共通パラメータ

以下のテーブルは後述のAPI Requestにおいて用いる共通のパラメータを示しています。
Common Request Parameter
パラメータ名 説明 必須 DATATYPE
Action 実行するactionを指定します。 Yes  
AuthParams ※現時点で未対応です。 No  
AWSAccessKeyID requestの認証に必要なRDBのSecret Access Keyに対となるAccess Key IDを指定します。 Default : None Yes String
Expires ※現時点で未対応です。requestの有効期限の日時です。表記方法は「YYYY-MM-DDThh:mm:ssZ」で、 ISO8601準拠です。 Default : None (※1) String
SecurityToken ※現時点で未対応です。AWSの「AWS Security Token Service」を 利用する事により取得できる一時的なセキュ リティートークンです。Default : None   String
Signature API requestのために作成されたデジタル署名です。署名を生成する方法については、 サービスの開発者用ドキュメントを参照してください。Default : None Yes String
SignatureMethod API requestに利用するデジタル署名生成のhash algorithmです。 Default : None Valid Values : HmacSHA256 Yes String
SignatureVersion シグネチャのバージョンは、リクエストに署名するために使用します。ご利用製品のマニ ュアルのセキュリティーに関する推奨値に設定してください。 Signatureのバージョンは“2”のみ対応です。 Default : None Yes String
Timestamp APIのrequestを発出した日時です。表記方法は「YYYY-MM-DDThh:mm:ssZ」で、ISO8601準拠です。 Default : None Yes (※1) String
Version 使用するAPIのversionの事です。表記方法は、YYYY-MM-DDです。 また、ご提供するのは2011-01-01のバージョンのみです。 Yes  

注釈

(※1). requestにはTimestampかExpiresのどちらかを指定する必要があります。 現時点ではExpiresを提供していないため、Timestampを指定する必要があります。

[参考]前提知識

Cloudn AutoScalingについて

Cloudn AutoScaling の操作・機能については操作マニュアルを参照してください。

クラウド・エヌ インフォメーションポータル - マニュアル

APIの利用方法について

APIを利用するには、クライアントと呼ばれるツールを利用する方法、
もしくはお客様プログラム上において仕様にしたがってAPIを利用する方法が一般的です。

以下、APIクライアントを利用した利用例・プログラム上でAPIを利用するために必要なリクエストの作成例を示します。

注釈

APIのご利用にあたっては、ご利用前に、 Cloudn ポータルより サービスを「利用中」の状態にする必要があります。

1.3. APIクライアントの利用

概要

Cloudn AutoScalingでは、Amazon Auto Scaling 互換APIを提供しており、
各種AWS対応APIツールを利用することが可能です。

APIクライアントとして、下記に示すツールを用いた例をご説明します。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# coding: utf-8

require "cgi"
require "time"
require "digest/hmac"
require "base64"
require "net/http"
require "net/https"
require 'pp'


def cgi_escape(key, value)
  [CGI.escape(key.to_s), CGI.escape(value.to_s)].join("=")
end

end_point = "Please Enter the Endpoint"
access_identifier = "Please Enter your API Access Key"
secret_identifier = "Please enter your Secret Key"

if ARGV.size < 1 then
  puts "usage :./kick_api.rb Action=... parameter=... parameter=..."
  exit 1
end

params = {
  "AWSAccessKeyId" => access_identifier,
  "SignatureMethod" => "HmacSHA256",
  "SignatureVersion" => 2,
  "Version" => "2011-01-01",
  "Timestamp" => Time.now.iso8601
}

ARGV.each do |arg|
  key, value = arg.split("=")
  params[key] = value
end

canonical_querystring = params.sort.collect { |key, value| cgi_escape(key, value) }.join("&")

  string_to_sign ="GET
#{end_point}
/
#{canonical_querystring}"
pp string_to_sign
hmac = Digest::HMAC.new(secret_identifier, Digest::SHA256)
hmac.update(string_to_sign)
signature = Base64.encode64(hmac.digest).chomp

params["Signature"] = signature
querystring = params.collect { |key, value| cgi_escape(key, value) }.join("&")


get = Net::HTTP::Get.new("/?#{querystring}")
https = Net::HTTP.new(end_point, 443)

https.use_ssl = true
https.verify_mode = OpenSSL::SSL::VERIFY_PEER
response = nil
https.start{ |w|
  response = w.request(get)
p response.header
puts response.body

}
pp response

KickAPIの利用

前提条件
  • Ruby1.9.2p0 以上での動作
KickAPIのダウンロード
上記のリンクよりKickAPIをダウンロードします。
次に、秘密鍵・APIアクセスキーを設定します。
エディタなどでダウンロードしたKickAPIを開き、編集します。

以下、APIアクセスキーを”WNZ9AV783OKRC8C5DL4Q”, 秘密鍵を”Q5j2kslNp5L7mnpJGZwS9AdkJla9V08vZ0JalhGl”、
および米国リージョン・FLATタイプを利用すると仮定し設定します。
vim kick_api.rb

下記の変更を行います。

  • 上記コードでハイライトされた部分を編集します

    • “Please Enter the Endpoint” へ 対象リージョン・タイプのエンドポイントホスト部
    • “Please Enter your API Access Key” へ APIアクセスキーの “WNZ9AV783OKRC8C5DL4Q” を入力
    • “Please Enter your Secret Key” へ 秘密鍵の “Q5j2kslNp5L7mnpJGZwS9AdkJla9V08vZ0JalhGl” を入力

例の場合、変更した点は以下の通りです。

@@ -16,8 +16,8 @@

-end_point = "Please Enter the Endpoint"
-access_identifier = "Please Enter your API Access Key"
-secret_identifier = "Please Enter your Secret Key"
+end_point = "mon-api.us-e1.cloudn-service.com"
+access_identifier = "WNZ9AV783OKRC8C5DL4Q"
+secret_identifier = "Q5j2kslNp5L7mnpJGZwS9AdkJla9V08vZ0JalhGl"

参考

API認証情報については以下を参照してください

エンドポイントについては以下を参照してください

上記ファイルを保存します。

KickAPIの利用
シェルにて下記のように実行します
下記のコマンドで、現在あるメトリクス一覧を取得するAPI ( ../AWSStyle/ManageMetrics/ListMetrics )
を利用可能です。
$ruby kick_api.rb Action=ListMetrics

コマンド引数は以下の通りです。

  • “Action=”

    • APIのアクション名を指定します。この場合、 “ListMetrics” というActionをコールしています
  • その他パラメータ (例: “MetricName=autoscalinggroup1”)

    • API固有のパラメータを上記の形式で入力します。

上記の様に、クライアントを利用することでAPIの実行に必要な署名の作成といった作業が簡略化されます。

1.4. リクエスト作成方法

APIクライアントなどを使用せずにAPIリクエストを利用する方法を示します。

APIリクエスト形式

Cloudn AutoScalingサービスのリクエストは、Query API形式となります。
例えば、本サービスによって起動設定を作成する CreateLaunchConfiguration API リクエストは、以下のようになります。
https://as-api.jp-e1.cloudn-service.com?Action=CreateLaunchConfiguration&SignatureVersion=2&AWSAccesskeyId=<APIKey>&Timestamp=2014-12-01T04%3A08%3A07Z&Signature=<Signature>&ImageId=12345678-e544-4f2b-a231-eac693867f2e&SignatureMethod=HmacSHA256&Version=2011-01-01&LaunchConfigurationName=LaunchDemo&InstanceType=t1.micro
上記では例として AutoScaling でサポートされるリクエストを記載しています。
APIリクエストは、主に命令の種類とそのオプションの値を含み、下記の要素で構成されます。
https://as-api.jp-e1.cloudn-service.com
Action=CreateLaunchConfiguration
ImageId=12345678-e544-4f2b-a231-eac693867f2e
InstanceType=t1.micro
LaunchConfigurationName=LaunchDemo
Version=2011-01-01
SignatureVersion=2
SignatureMethod=HmacSHA256
Timestamp=2014-12-01T04%3A08%3A07Z
AWSAccessKeyId=<APIKey>
Signature=<Signature>

構成要素は以下の通りです。

  • 1行目: APIサーバ/エンドポイントURL
  • 2行目: AutoScalingへのコマンド (Action)
  • 3-5行目: コマンドに渡すオプションとその値
  • 6-11行目: 署名情報

リクエスト本文に署名を付ける手順を説明します。

署名

APIリクエストには、リクエスト内容を保証するために、署名(Signature)を加えます。
署名は、リクエスト本文(1の要素を元に作成)を元に、ユーザのSECRETKEYとHMAC-SHA-256ハッシュアルゴリズムを組み合わせて作成します。
予めサービス利用に必要な公開鍵と秘密鍵を配布しています。
サービス上ではこれをAPIアクセスキーと秘密鍵と呼びます。
APIアクセスキーと秘密鍵については アクセスキーID・秘密鍵入手方法 を参照してください。
署名の作成手順
以下では署名とHTTPリクエストの生成方法について解説します。


リクエストのコマンドパラメータを作成します。
AutoScalingグループ内容を取得するリクエスト作成を例に、コマンドパラメータを記載します。
コマンド, パラメータ
Action DescribeAutoScalingGroups
Version 2011-01-01
SignatureVersion 2
SignatureMethod HmacSHA256
Timestamp 2014-08-14T11:11:15+09:00
AWSAccessKeyId <APIKEY>

注釈

コマンド,およびパラメータは大文字小文字を区別します

注釈

Timestamp key は、リクエスト発行時の時刻をiso8601形式で作成します。

  • (例): 2014-08-14T11:10:03+09:00
    • マイクロ秒は必要ありません。
    • 日付時刻の間のdelimiterは “T” です
    • オフセットを(+-)00:00の形式で付与する必要があります

次に署名を作成します。

作成したコマンドパラメータを、ASCIIの昇順で並べ替え、値をURLエンコードします。
本操作は署名の作成のために行うもので、リクエスト本文自体が並べ替えられるわけではありません。
(リクエスト本文はソートされている必要はありません)
コマンド, パラメータ
AWSAccessKeyId <APIKEY>
Action DescribeAutoScalingGroups
SignatureMethod HmacSHA256
SignatureVersion 2
Timestamp 2014-08-14T11%3A11%3A15%2B09%3A00
Version 2011-01-01
上表の “コマンド, パラメータ” 行と “値” 行を、”=” にてつないだものを “&” で接続し、
HTTPリクエストの要素を添えて署名対象文字列(“data”)の作成します。

以下の文字列をここでは “data” とします:

GET
https://as-api.jp-e1.cloudn-service.com
AWSAccessKeyId=<APIKey>&Action=DescribeAutoScalingGroups&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-01-30T18%3A09%3A45Z&Version=2011-01-01

注釈

“AWSAccessKeyId=〜”クエリまでは各要素を改行しますが、クエリ部分は改行せず1行で作成します

作成した文字列”data”に対して、HMAC-SHA256と秘密鍵から署名を生成し、 これをHTTPリクエストに含められるようにBase64でエンコードします。

  • HMAC-SHA256:

    • 暗号化形式です
    • OpenSSL等のライブラリの機能を利用し、作成します
    • (例:Rubyであればgemライブラリの ruby-hmac(0.4.0) など)
  • SECRETKEY:

    • 弊社から配布された物をご利用ください
  • HMACによる署名サンプル:

    • 5df60c66d6715d33c5b49af3428c0cbb84918a0baa96c29f3b32670a742bdc29
  • 署名サンプル:(Base64エンコード後)

    • NWRmNjBjNjZkNjcxNWQzM2M1YjQ5YWYzNDI4YzBjYmI4NDkxOGEwYmFhOTZjMjlmM2IzMjY3MGE3NDJiZGMyOQ==

注釈

署名内に改行が入らないようにご注意ください

署名(Signature)をリクエスト本文に付け加え、リクエスト文字列を作成します。
パラメータの値は予めURLエンコードしておきます。
コマンド、パラメータの記述を コマンド、パラメータ=値(valueはURLエンコード済)とし、各パラメータを&で繋ぎます。

なお、HTTPリクエストでは項目をソートする必要はありません。
Action=DescribeAutoScalingGroups&SignatureMethod=HmacSHA256&SignatureVersion=2&AWSAccessKeyId=<APIKEY>&Version=2011-01-01&Timestamp=2013-01-30T18%3A09%3A45Z&Signature=NWRmNjBjNjZkNjcxNWQzM2M1YjQ5YWYzNDI4YzBjYmI4NDkxOGEwYmFhOTZjMjlmM2IzMjY3MGE3NDJiZGMyOQ%3D%3D%0D%0A
作成したリクエスト本文を元に、HTTPSでエンドポイントに対しGETリクエストを実行します。
エンドポイントは Endpoint を参照してください。
GET /? Action=DescribeAutoScalingGroups&SignatureMethod=HmacSHA256&SignatureVersion=2&AWSAccessKeyId=<APIKEY>&Version=2011-01-01&Timestamp=2013-01-30T18%3A09%3A45Z&Signature=NWRmNjBjNjZkNjcxNWQzM2M1YjQ5YWYzNDI4YzBjYmI4NDkxOGEwYmFhOTZjMjlmM2IzMjY3MGE3NDJiZGMyOQ%3D%3D%0D%0A

2. Amazon Auto Scaling 互換API

Amazon Auto Scaling 互換APIは以下の通りです。

2.1. 起動設定管理

起動設定を管理するためのAPIコマンドです。

CreateLaunchConfiguration - 起動設定を作成する

概要
起動設定を作成するAPIです。
起動設定の名称は、アカウント内で一意である必要があります。
また、登録可能な起動設定の上限値(100件)を超えて登録を試みた場合、起動設定の作成はできません。

作成要求が完了すると、すぐに新たな起動設定が利用可能になります。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「CreateLaunchConfiguration」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AssociatePublicAddress ※現時点では未対応です。パブリックIPアドレスを許可するか設定 No Boolean
BlockDeviceMappings.member.N ディスクオファリング名。オートスケールにより起動されるVMに、 追加でディスクをアタッチする場合、指定します。(1件のみ指定可) (例:”Datadisk 40GB” ※ URLエンコードの際は、 半角スペースを%20に変換する必要があります。) No BlockDevice Mapping list
EbsOptimized ※現時点では未対応です。 No Boolean
IamInstanceProfile ※現時点では未対応です。 No String
ImageId テンプレートID No String
InstanceId ※現時点では未対応です。インスタンスID No String
InstanceMonitoring インスタンスモニタリング。有効にすると、 この起動設定を用いて作成されたAutoScalingグループに対して、 GroupDesiredCapacity(DesiredCapacityの変位を監視する項目)など Monitoringのメトリクスを設定することができるようになります。 デフォルトでは有効に設定されています。(メトリクスの設定については、 EnableMetricsCollection、DisableMetricsCollectionもご確認ください) No Instance Monitoring
InstanceType 仮想サーバプラン。(例:”t1.micro”) No String
KernelId ※現時点では未対応です。 No String
KeyName キーペア名。ComputeのAPIにて、事前に”CreateSSHKeyPair”を実行し、 作成した鍵の名称を入力します。 鍵認証に対応したテンプレートを利用する必要があります。 No String
LaunchConfigurationName 起動設定名(お客様任意の名前) Yes String
PlacementTenancy ※現時点では未対応です。 No String
RamdiskId ※現時点では未対応です。 RAMディスクID No String
SecurityGroups.member.N セキュリティグループリスト。オートスケールにより起動される VMに対して割り当てるセキュリティグループの名前を指定します。 No String
SpotPrice ※現時点では未対応です。 No String
UserData ※現時点では未対応です。 No String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=CreateLaunchConfiguration \
 LaunchConfigurationName=LaunchConfDemo \
 ImageId=9fe2bd7c-e544-4f2b-a231-eac693867f2e \
 InstanceType=t1.micro \
サンプルレスポンス
<Net::HTTPOK 200 OK readbody=true>
 <CreateLaunchConfigurationResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
  <ResponseMetadata>
   <RequestId>40898b03-41e0-eadd-5ae0-b6888df5f190</RequestId>
  </ResponseMetadata>
 </CreateLaunchConfigurationResponse>
<Net::HTTPOK 200 OK readbody=true>

DescribeLaunchConfigurations - 起動設定を表示する

概要
作成した起動設定の内容を表示するAPIです。
起動設定名をパラメータで指定しない場合は、すべての起動設定の内容を表示します。

最大取得件数の指定により、件数超過で取得できなかった起動設定が存在する場合は、
NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、
件数を超過した続きから起動設定を取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeLaunchConfigurations」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
LaunchConfigurationNames.member.N 起動設定名リスト No String list
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=DescribeLaunchConfigurations
サンプルレスポンス
<DescribeLaunchConfigurationsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <DescribeLaunchConfigurationsResult>
   <LaunchConfigurations>
     <member>
       <SecurityGroups>
       </SecurityGroups>
       <CreatedTime>2014-09-16T02:54:55Z</CreatedTime>
       <LaunchConfigurationName>LaunchConfDemo</LaunchConfigurationName>
       <KernelId/>
       <UserData></UserData>
       <InstanceType>t1.micro</InstanceType>
       <LaunchConfigurationARN>arn:cloudn:autoscale:jp-e1:cln100098244:launchConfiguration:launchConfigurationName/LaunchConfDemo</LaunchConfigurationARN>
       <BlockDeviceMappings>
       </BlockDeviceMappings>
       <ImageId>9fe2bd7c-e544-4f2b-a231-eac693867f2e</ImageId>
       <KeyName></KeyName>
       <RamdiskId/>
       <InstanceMonitoring>
         <Enabled>true</Enabled>
       </InstanceMonitoring>
     </member>
   </LaunchConfigurations>
 </DescribeLaunchConfigurationsResult>
 <ResponseMetadata>
   <RequestId>9420bfbb-407c-3046-ded0-91c03cc065d9</RequestId>
 </ResponseMetadata>
</DescribeLaunchConfigurationsResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

DeleteLaunchConfiguration - 起動設定を削除する

概要
AutoScalingグループに割り当てられていない、特定の起動設定を削除するAPIです。
削除要求が完了すると、起動設定は利用不可となります。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DeleteLaunchConfiguration」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
LaunchConfigurationName 起動設定名 Yes String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=DeleteLaunchConfiguration \
 LaunchConfigurationName=LaunchConfDemo \
サンプルレスポンス
<DeleteLaunchConfigurationResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>fdf5605f-7960-dd86-5a6d-98da6aa1b1ff</RequestId>
 </ResponseMetadata>
</DeleteLaunchConfigurationResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

2.2. グループ管理

AutoScalingグループを管理するためのAPIコマンドです。

CreateAutoScalingGroup - AutoScalingグループの作成

概要
新規にAutoScalingグループを作成するAPIです。
作成要求が完了すると、新たに作成されたAutoScalingグループを他のAPIから呼び出すことが可能になります。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「CreateAutoScalingGroup」を指定します。
Header 無し
Body 無し
リクエストパラメータ
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名(お客様任意の名前) Yes String
AvailabilityZones.member.N AutoScalingグループが利用できるZoneのリスト Yes String list
DBSecurityGroupName AutoScalingと連携させるDBセキュリティグループの名前を指定します。※注1 No String
DefaultCooldown クールダウン時間初期値。スケーリング動作後、 次のスケーリング動作に移るまでの時間を秒単位で指定します。(デフォルト:300秒) No Integer
DesiredCapacity

希望インスタンス数。 AutoScalingグループ内で動作させるVMの数を指定します。 Min Size(最小インスタンス数)以上、MaxSize(最大インスタンス) 以下である必要があります。

(デフォルト:MinSize(最小インスタンス数)と同値)
No Integer
HealthCheckGracePeriod ヘルスチェック猶予時間。新たなVMが生成された際に、 ヘルスチェックを無視する時間を秒単位で指定します。(デフォルト:0秒) No Integer
HealthCheckType ヘルスチェック種別。”CnLBA”もしくは”CnC”を指定します。 ”CnLBA”を指定した場合、LBAによるヘルスチェックを行います。”CnC”を指定した場合、 Computeによるヘルスチェックを行います。(デフォルト:”CnC”) No String
InstanceId ※現時点では未対応です。インスタンスID No String
LaunchConfigurationName 起動設定名 Yes String
LoadBalancerNames.member.N ロードバランサ名リスト。 AutoScalingで生成したVMをアタッチするロードバランサの名前を指定します。 No
String
list
MaxSize 最大インスタンス数。AutoScalingグループ内で生成されるVM数の上限を指定します。 Yes Integer
MinSize 最小インスタンス数。AutoScalingグループ内で生成されるVM数の下限を指定します。 Yes Integer
PlacementGroup ※現時点で対応しておりません。 No String
Tags.member.N ※現時点で対応しておりません。 No Tag list
TerminationPolicies.member.N

インスタンス削除ポリシーリスト。 以下のインスタンス削除ポリシーから文字列で選択します。

”OldestInstance” : AutoScalingグループ内の最も古いインスタンスから削除します。 ”NewestInstance” : AutoScalingグループ内の最も新しいインスタンスから削除します。 ”OldestLaunchConfiguration” : もっとも古いLaunchConfigurationを使用して起動された インスタンスから削除します。 ”Default” : OldestLaunchConfigurationと同様の動作をします。
No
String
list
VPCZoneIdentifier VPCゾーン識別子。VMを生成するサブネットのIDを指定します。 複数指定する場合は、カンマ区切りでサブネットIDを指定します。 ※注2 String

注釈

※注1: 東日本FLATタイプ限定のパラメータになります。

※注2: FLATタイプでは、VPCZoneIdentifierを指定するとエラーになります。 VPCタイプ OpenNWでは、利用者自身でサブネットを作成して、 サブネットIDをVPCZoneIdentifierに指定する必要があります。

サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=CreateAutoScalingGroup \
 AutoScalingGroupName=GroupDemo \
 MaxSize=3 \
 MinSize=1 \
 LaunchConfigurationName=LaunchConfDemo \
 AvailabilityZones.member.N=jp-e1a \
サンプルレスポンス
<CreateAutoScalingGroupResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>2a1cf9d4-cecf-1bc2-71eb-5c2ca73ef532</RequestId>
 </ResponseMetadata>
</CreateAutoScalingGroupResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
AlreadyExists 同じ名前のAutoScalingグループやLaunch Configurationが存在する。 HTTP Status Code:400
LimitExceeded 割り当てリソースをすでに超えている。 HTTP Status Code:400

DeleteAutoScalingGroup - AutoScalingグループの削除

概要
VMのインスタンスが存在せず、さらにスケーリングが進行中でないAutoScalingグループを指定し、削除するAPIです。
(UpdateAutoScalingGroupを実行し、AutoScalingグループの現状台数(DesiredCapacity)を0にすることで、すべてのVMインスタンスをAutoScalingグループから除外することができます。)
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DeleteAutoScalingGroup」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
ForceDelete 強制削除。Trueの場合、VMの存在有無やスケーリングの進行状況にかかわらず、 AutoScalingグループを削除します。(デフォルト:False) No Boolean
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=DeleteAutoScalingGroup \
 AutoScalingGroupName=GroupDemo \
 ForceDelete=True \
サンプルレスポンス
<DeleteAutoScalingGroupResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>ddbfd014-3abe-3528-4f46-90817db03ed1</RequestId>
 </ResponseMetadata>
</DeleteAutoScalingGroupResponse>

DescribeAutoScalingGroups - AutoScalingグループ内容を表示する

概要
作成したAutoScalingグループの内容を表示します。
AutoScalingグループ名をパラメータで指定しない場合は、すべてのAutoScalingグループの内容を表示します。

最大取得件数の指定により、件数超過で取得できなかったAutoScalingグループが存在する場合は、NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、件数を超過した続きからAutoScalingグループを取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeAutoScalingGroups」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupNames.member.N AutoScalingグループ名をリスト形式で指定します。 No String list
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=DescribeAutoScalingGroups
サンプルレスポンス
<DescribeAutoScalingGroupsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <DescribeAutoScalingGroupsResult>
   <AutoScalingGroups>
     <member>
       <Tags/>
       <SuspendedProcesses>
       </SuspendedProcesses>
       <AutoScalingGroupName>GroupDemo</AutoScalingGroupName>
       <HealthCheckType>CnC</HealthCheckType>
       <CreatedTime>2014-09-16T04:29:22Z</CreatedTime>
       <EnabledMetrics>
       </EnabledMetrics>
       <LaunchConfigurationName>LaunchConfDemo</LaunchConfigurationName>
       <Instances>
         <member>
           <HealthStatus>HEALTHY</HealthStatus>
           <AvailabilityZone>jp-e1a</AvailabilityZone>
           <InstanceId>13ed9be4-6ca6-4034-8916-3484cc6aab52</InstanceId>
           <LaunchConfigurationName>LaunchConfDemo</LaunchConfigurationName>
           <LifecycleState>Running</LifecycleState>
         </member>
       </Instances>
       <DesiredCapacity>1</DesiredCapacity>
       <AvailabilityZones>
         <member>jp-e1a</member>
       </AvailabilityZones>
       <LoadBalancerNames>
       </LoadBalancerNames>
       <MinSize>1</MinSize>
       <VPCZoneIdentifier/>
       <HealthCheckGracePeriod>0</HealthCheckGracePeriod>
       <DefaultCooldown>300</DefaultCooldown>
       <AutoScalingGroupARN>arn:cloudn:autoscale:jp-e1:cln100098244:autoScalingGroup:autoScalingGroupName/GroupDemo</AutoScalingGroupARN>
       <TerminationPolicies>
         <member>Default</member>
       </TerminationPolicies>
       <MaxSize>3</MaxSize>
     </member>
   </AutoScalingGroups>
 </DescribeAutoScalingGroupsResult>
 <ResponseMetadata>
   <RequestId>a8752f87-b3a4-2631-43e6-0b71cf2d8ddc</RequestId>
 </ResponseMetadata>
</DescribeAutoScalingGroupsResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

DescribeAutoScalingInstances - インスタンスの表示

概要
AutoScalingで生成したインスタンス(VM)を表示します。インスタンスID(VMの名前)を指定しない場合は、すべてのインスタンスを表示します。
最大取得件数の指定により、件数超過で取得できなかったAutoScalingインスタンスが存在する場合は、NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、件数を超過した続きからAutoScalingインスタンスを取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeAutoScalingInstances」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
InstanceIds.member.N インスタンスID(VMの名前)をリスト形式で指定します。 No String list
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String

DescribeScalingActivities - スケーリング処理の履歴表示

概要
AutoScalingグループで既に実行を開始したスケーリング処理の履歴を表示します。
AutoScalingグループ名およびスケーリング処理IDをパラメータで指定しない場合、すべてのスケーリング処理の内容が表示されます。

最大取得件数の指定により、件数超過で取得できなかったスケーリング処理が存在する場合は、
NextTokenがレスポンスとして出力されます。このNextTokenを入力時に指定することで、件数を超過した続きからスケーリング処理を取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeScalingActivities」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
ActivityIds.member.N AutoScalingを実行した際のスケーリング処理IDをリスト形式で指定します。 No String list
AutoScalingGroupName AutoScalingグループ名 No String
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
Activity AutoScaling実行履歴。VMを削除したスケーリング処理の内容が返ります。 ActivityId,AutoScalingGroupName Cause,Description,Progress StartTime,StatusCode
ActivityId 実行履歴ID。スケーリング処理に対して一意に割り当てられます。  
AutoScalingGroupName AutoScalingグループ名  
Cause 実行理由  
Description 説明  
Progress 進捗  
StartTime 開始時刻  
StatusCode ステータスコード。以下のうちいずれかを表します。 ・”PreInService” : 処理が実行前であることを表します。 ・”InProgress” : 処理が進行中であることを表します。 ・”Successful” : 処理が終了し、成功したことを表します。 ・”Failed” : 処理が終了し、失敗したことを表します。 ・”Cancelled” : スケジュール実行された処理が何らかの起因により 中断された場合を表します。  

DescribeScalingProcessTypes - スケーリング処理種別の表示

概要
ResumeProcesses(API)でスケーリング処理を中断、もしくはSuspendProcesses(API)でスケーリング処理を再開する際に指定可能な、処理種別を取得します。
以下のスケーリング処理種別が存在します。

・“Launch” : VMを生成する際のプロセスを表します。
・“Terminate” : VMを削除する際のプロセスを表します。
・“AddToLoadBalancer” : VM生成時にロードバランサへ登録する際のプロセスを表します。
・“AlarmNotification” : Monitoringからアラームを受信する際のプロセスを表します。
・“AZRebalance” : 複数のサブネットに対しAutoScalingグループを設定している場合、サブネット間のVM数を均等に揃える際のプロセスを表します。(未サポート)
・“HealthCheck” : VMのヘルスチェックを実施する際のプロセスを表します。
・“ReplaceUnhealthy” : Unhealthyと判定されたVMを新たに生成するHealthyなVMに置き換える際のプロセスを表します。
・“ScheduledActions” : スケジュール実行されるスケーリング処理を表します。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeScalingProcessTypes」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
なし      
レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
Processes AutoScalingプロセス種別 ProcessName
ProcessName
プロセス種別。以下のいずれかを表します。
・“Launch” : VMを生成する際のプロセスを表します。 ・“Terminate” : VMを削除する際のプロセスを表します。 ・“AddToLoadBalancer” : VM生成時にロードバランサへ 登録する際のプロセスを表します。 ・“AlarmNotification” : Monitoringからアラームを 受信する際のプロセスを表します。 ・“AZRebalance” : 複数のサブネットに対しAutoScalingグループを 設定している場合、サブネット間のVM数を均等に揃える 際のプロセスを表します。(未サポート) ・“HealthCheck” : VMのヘルスチェックを実施する際のプロセスを表します。 ・“ReplaceUnhealthy” : Unhealthyと判定されたVMを新たに生成する HealthyなVMに置き換える際のプロセスを表します。 ・“ScheduledActions” : スケジュール実行される スケーリング処理を表します。
 

ResumeProcesses - スケーリング処理の再開

概要
中断したスケーリング処理を再開するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「ResumeProcesses」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
ScalingProcesses.member.N

プロセスリスト。AutoScalingグループで実行されている スケーリング処理のうち、再開したい処理の種別を指定します。 以下のリストから選択可能です。

“Launch”:VMを生成する際のプロセスを表します。 “Terminate”:VMを削除する際のプロセスを表します。 “AddToLoadBalancer”:VM生成時にロードバランサへ 登録する際のプロセスを表します。 “AlarmNotification”:Monitoringからアラームを受信する際の プロセスを表します。 “AZRebalance”:複数のサブネットに対しAutoScalingグループを 設定している場合、サブネット間のVM数を均等に揃える際の プロセスを表します。(未サポート) “HealthCheck”:VMのヘルスチェックを実施する際のプロセスを表します。 “ReplaceUnhealthy”:Unhealthyと判定されたVMを新たに生成する HealthyなVMに置き換える際のプロセスを表します。 “ScheduledActions”:スケジュール実行されるスケーリング処理を表します。
No String list

SetDesiredCapacity - VM数を指定

概要
AutoScalingグループに設定するVM数を指定するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「SetDesiredCapacity」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
DesiredCapacity 希望インスタンス数。AutoScalingグループに設定するVM台数を指定します。 Yes Integer
HonorCooldown クールダウン時間優先。Trueを指定すると、 AutoScalingグループがスケーリング処理を終え、 設定されたクールダウン期間を終えていない場合は、エラーになります。 No Boolean

SetInstanceHealth - VMのヘルス状態の更新

概要
特定のVMのヘルス状態を更新するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「SetInstanceHealth」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
HealthStatus インスタンスヘルス状態。”Healthy”もしくは”Unhealthy”を指定します。 Yes String
InstanceId インスタンスID。VMの名前を指定します。 Yes String
ShouldRespectGracePeriod ヘルスチェック猶予時間優先。Trueを入力すると、指定したVMが、 生成したばかりでヘルスチェック猶予時間内にあるとき、 エラーを返します。Falseを入力すると、 ヘルスチェック猶予時間を無視してVMのインスタンスヘルス状態を更新します。 (デフォルト:True) No Boolean

SuspendProcesses - スケーリング処理の中断

概要
AutoScalingグループで実行されているスケーリング処理を中断するAPIです。
ScalingProcessesに処理種別を指定することで、特定の処理のみを中断することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「SuspendProcesses」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
ScalingProcesses.member.N

プロセスリスト。AutoScalingグループで実行されている スケーリング処理のうち、再開したい処理の種別を指定します。 以下のリストから選択可能です。

“Launch”:VMを生成する際のプロセスを表します。 “Terminate”:VMを削除する際のプロセスを表します。 “AddToLoadBalancer”:VM生成時にロードバランサへ 登録する際のプロセスを表します。 “AlarmNotification”:Monitoringからアラームを受信する際の プロセスを表します。 “AZRebalance”:複数のサブネットに対しAutoScalingグループを 設定している場合、サブネット間のVM数を均等に揃える際の プロセスを表します。(未サポート) “HealthCheck”:VMのヘルスチェックを実施する際のプロセスを表します。 “ReplaceUnhealthy”:Unhealthyと判定されたVMを新たに生成する HealthyなVMに置き換える際のプロセスを表します。 “ScheduledActions”:スケジュール実行されるスケーリング処理を表します。
No String list

TerminateInstanceInAutoScalingGroup - AutoScalingグループのVM削除

概要
AutoScalingグループ内の特定のVMを削除するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「TerminateInstanceInAutoScalingGroup」を指定します。
Header 無し
Body 無し
リクエストパラメータ
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
InstanceId インスタンスID。VMの名前を指定します。 Yes String
ShouldDecrementDesiredCapacity 希望インスタンス数減少。Trueを指定すると、 VMの削除時にAutoScalingグループのDesiredCapacityも同時に減少させます。 Falseを指定した場合、VMの削除時にDesiredCapacityを減少させません。 Yes Boolean
サンプルAPIコール&レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
Activity AutoScaling実行履歴。VMを削除したスケーリング処理の内容が返ります。 ActivityId,AutoScalingGroupName Cause,Description,Progress StartTime,StatusCode
ActivityId 実行履歴ID。スケーリング処理に対して一意に割り当てられます。  
AutoScalingGroupName AutoScalingグループ名  
Cause 実行理由  
Description 説明  
Progress 進捗  
StartTime 開始時刻  
StatusCode ステータスコード。以下のうちいずれかを表します。 ・”PreInService” : 処理が実行前であることを表します。 ・”InProgress” : 処理が進行中であることを表します。 ・”Successful” : 処理が終了し、成功したことを表します。 ・”Failed” : 処理が終了し、失敗したことを表します。 ・”Cancelled” : スケジュール実行された処理が何らかの起因により 中断された場合を表します。  
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
AlreadyExists 同じ名前のAutoScalingグループやLaunch Configurationが存在する。 HTTP Status Code:400
LimitExceeded 割り当てリソースをすでに超えている。 HTTP Status Code:400

UpdateAutoScalingGroup - AutoScalingグループの更新

概要
特定のAutoScalingグループの設定情報を更新します。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「UpdateAutoScalingGroup」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧

リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
AvailabilityZones.member.N 利用可能ゾーン名リスト。ゾーン名を文字列で指定します。(例:”jp-e1a”) No String list
DefaultCooldown クールダウン時間初期値。スケーリング動作後、 次のスケーリング動作に移るまでの時間を秒単位で指定します。 No Integer
DesiredCapacity 希望インスタンス数。AutoScalingグループ内で動作させるVMの数を指定します。 MinSize(最小インスタンス数)以上、 MaxSize(最大インスタンス数)以下である必要があります。 No Integer
HealthCheckGracePeriod ヘルスチェック猶予時間。新たなVMが生成された際に、 ヘルスチェックを無視する時間を秒単位で指定します。 No Integer
HealthCheckType ヘルスチェック種別。”CnLBA”もしくは”CnC”を指定します。 ”CnLBA”を指定した場合、LBAによるヘルスチェックを行います。 ”CnC”を指定した場合、Computeによるヘルスチェックを行います。 No String
LaunchConfigurationName 起動設定名 No String
MaxSize 最大インスタンス数。AutoScalingグループ内で生成されるVM数の上限を指定します。 No Integer
MinSize 最小インスタンス数。AutoScalingグループ内で生成されるVM数の下限を指定します。 No Integer
PlacementGroup ※現時点で対応しておりません。 No String
TerminationPolicies.member.N

インスタンス削除ポリシーリスト。 以下のインスタンス削除ポリシーから文字列で選択します。

・”OldestInstance” : AutoScalingグループ内の最も古いインスタンスから削除します。 ・”NewestInstance” : AutoScalingグループ内の最も新しいインスタンスから削除します。 ・”OldestLaunchConfiguration” : もっとも古いLaunchConfigurationを使用して起動されたインスタンスから削除します。 ・”Default” : OldestLaunchConfigurationと同様の動作をします。
No String list
VPCZoneIdentifier VPCゾーン識別子 ※注1 String

注釈

※注1: Compute FLATタイプでは、VPCZoneIdentifierを指定するとエラーになります。 Compute VPCタイプ OpenNWでは、利用者自身でサブネットを作成して、 サブネットIDをVPCZoneIdentifierに指定する必要があります。

サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=UpdateAutoScalingGroup \
 AutoScalingGroupName=GroupDemo \
 MaxSize=5 \
サンプルレスポンス
<UpdateAutoScalingGroupResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>9b86fe4e-fe0b-80e4-2152-922624173f7c</RequestId>
 </ResponseMetadata>
</UpdateAutoScalingGroupResponse>

2.3. 監視管理

AutoScalingグループをMonitoringから監視 するためのAPIコマンドです。

DisableMetricsCollection - AutoScalingグループ監視の無効化

概要
AutoScalingグループに対して、設定したメトリクス(監視項目)を無効化するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DisableMetricsCollection」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName 適用するAutoScalingグループ名 Yes String
Metrics.member.N
メトリクスリスト。以下のメトリクスをリスト形式で指定可能です。
・”GroupMinSize” : AutoScalingグループの最小インスタンス数の変位を監視します。 ・”GroupMaxSize” : AutoScalingグループの最大インスタンス数の変位を監視します。 ・”GroupDesiredCapacity” : AutoScalingグループの希望インスタンス数 (グループ内に存在するVM数)の変位を監視します。 ・”GroupInServiceInstances” : AutoScalingグループの中で稼動している (Running状態である)VM数の変位を監視します。 ・”GroupPendingInstances” : AutoScalingグループの中で起動中の (Starting状態である)VM数の変位を監視します。 ・”GroupTerminatingInstances” : AutoScalingグループの中で停止中の (Stopping状態である)VM数の変位を監視します。 ・”GroupTotalIntstances” : AutoScalingグループに属する全VMの数 (起動中および停止中状態のVMも含む)の変位を監視します。
No String list

EnableMetricsCollection - AutoScalingグループ監視

概要
AutoScalingグループに対して、メトリクス(監視項目)を設定します。
設定したメトリクスは、Monitoringサービスより確認することができます。
(※メトリクスを設定可能なAutoScalingグループは、AutoScalingグループに割り当てられた起動設定の作成時に、インスタンスモニタリングを有効化していたものに限られます。)
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「EnableMetricsCollection」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
Granularity 粒度。監視間隔を指定します。現在は”1Minute”(1分間隔)のみ指定できます。 Yes String
Metrics.member.N
メトリクスリスト。以下のメトリクスをリスト形式で指定可能です。
・”GroupMinSize” : AutoScalingグループの最小インスタンス数の変位を監視します。 ・”GroupMaxSize” : AutoScalingグループの最大インスタンス数の変位を監視します。 ・”GroupDesiredCapacity” : AutoScalingグループの希望インスタンス数 (グループ内に存在するVM数)の変位を監視します。 ・”GroupInServiceInstances” : AutoScalingグループの中で稼動している (Running状態である)VM数の変位を監視します。 ・”GroupPendingInstances” : AutoScalingグループの中で起動中の (Starting状態である)VM数の変位を監視します。 ・”GroupTerminatingInstances” : AutoScalingグループの中で停止中の (Stopping状態である)VM数の変位を監視します。 ・”GroupTotalIntstances” : AutoScalingグループに属する全VMの数 (起動中および停止中状態のVMも含む)の変位を監視します。
No String list
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=EnableMetricsCollection AutoScalingGroupName=GroupDemo Granularity=1Minute
サンプルレスポンス
<EnableMetricsCollectionResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>ab12b646-7a04-aa4e-74f3-5ce977183a83</RequestId>
 </ResponseMetadata>
</EnableMetricsCollectionResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

2.4. メール通知管理

メール通知を管理するためのAPIコマンドです。

DeleteNotificationConfiguration - メール設定を削除する

概要
AutoScalingグループに設定された通知設定を削除するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DeleteNotificationConfiguration」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
TopicARN メールアドレスをカンマ区切りで指定します。 Yes  
サンプルレスポンス
<DeleteNotificationConfigurationResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
  <RequestId>12345678-6e90-7f3f-bfe0-5220c176ca22</RequestId>
 </ResponseMetadata>
</DeleteNotificationConfigurationResponse>

DescribeAutoScalingNotificationTypes - メール通知の種別表示

概要
AutoScalingで利用可能なメール通知の種別を表示します。
以下の通知種別が利用可能です。

・”autoscaling:Compute_INSTANCE_LAUNCH” : VMの起動時に通知
・”autoscaling:Compute_INSTANCE_LAUNCH_ERROR” : VMの起動に失敗した際に通知
・”autoscaling:Compute_INSTANCE_TERMINATE” : VMの削除時に通知
・”autoscaling:Compute_INSTANCE_TERMINATE_ERROR” : VMの削除に失敗した際に通知
・”autoscaling:TEST_NOTIFICATION” : 本API実行時に通知
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeAutoScalingNotificationTypes」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
なし      
レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
AutoScalingNotificationTypes 通知種別  

DescribeNotificationConfigurations - メール設定通知内容を表示する

概要
AutoScalingグループに割り当てられた各種通知設定を表示します。
AutoScalingグループをパラメータで指定しない場合、すべての通知設定が表示されます。
最大取得件数の指定により、件数超過で取得できなかった通知設定が存在する場合は、
NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、件数を超過した続きから通知設定を取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeNotificationConfigurations」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupNames.member.N AutoScalingグループ名をリスト形式で指定します。 No String list
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
NextToken 次回開始位置  
NotificationConfiguration 通知設定リスト AutoScalingGroupName, NotificationType,TopicARN
AutoScalingGroupName AutoScalingグループ名  
NotificationType
通知種別リスト。以下のうちいずれかを表します。
“autoscaling:Compute_INSTANCE_LAUNCH”:インスタンスの起動時に通知 “autoscaling:Compute_INSTANCE_LAUNCH_ERROR”: インスタンスの起動に失敗した際に通知 “autoscaling:Compute_INSTANCE_TERMINATE”:インスタンスの削除時に通知 “autoscaling:Compute_INSTANCE_TERMINATE_ERROR”: インスタンスの削除に失敗した際に通知 “autoscaling:TEST_NOTIFICATION”:本API実行時に通知
 
TopicARN メールアドレスをカンマ区切りで表します。  
サンプルレスポンス
<DescribeNotificationConfigurationsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <DescribeNotificationConfigurationsResult>
  <NotificationConfigurations>
   <member>
    <AutoScalingGroupName>test-auto-scaling-group</AutoScalingGroupName>
    <NotificationType>autoscaling:TEST_NOTIFICATION</NotificationType>
    <TopicARN>user1@example.com</TopicARN>
   </member>
  </NotificationConfigurations>
 </DescribeNotificationConfigurationsResult>
 <ResponseMetadata>
  <RequestId>12345678-1746-c08e-2bf4-9ce47892a9f9</RequestId>
 </ResponseMetadata>
</DescribeNotificationConfigurationsResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

PutNotificationConfiguration - メール通知を設定する

概要
AutoScalingに関するイベントが発生した際の通知設定を、AutoScalingグループに対して行うAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「PutNotificationConfiguration」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
NotificationTypes.member.N
通知種別リスト。以下のうちいずれかを指定します。
“autoscaling:Compute_INSTANCE_LAUNCH”:インスタンスの起動時に通知 “autoscaling:Compute_INSTANCE_LAUNCH_ERROR”: インスタンスの起動に失敗した際に通知 “autoscaling:Compute_INSTANCE_TERMINATE”:インスタンスの削除時に通知 “autoscaling:Compute_INSTANCE_TERMINATE_ERROR”: インスタンスの削除に失敗した際に通知 “autoscaling:TEST_NOTIFICATION”:本API実行時に通知
Yes String list
TopicARN メールアドレスをカンマ区切りで指定します。 Yes  
サンプルリクエスト
<PutNotificationConfigurationResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
  <RequestId>12345678-e3e8-c1cd-dafd-84d8796ea719</RequestId>
 </ResponseMetadata>
</PutNotificationConfigurationResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
LimitExceeded 割り当てリソースをすでに超えている。 HTTP Status Code:400

2.5. タグ管理

AutoScalingグループおよびVMインスタンスのタグを 管理するためのAPIコマンドです。

CreateOrUpdateTags - タグを付与する

概要
AutoScalingグループおよびVMインスタンスにタグを付与する、もしくはAutoScalingグループに設定済のタグを更新するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「CreateOrUpdateTags」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
Tags.member.N タグをリスト形式で指定します。 Yes Tag list
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb
サンプルレスポンス
<CreateOrUpdateTagsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
  <RequestId>7cd1c551-94de-4aad-591a-364938cc9832</RequestId>
 </ResponseMetadata>
</CreateOrUpdateTagsResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
AlreadyExists 同じ名前のAutoScalingグループやLaunch Configurationが存在する。 HTTP Status Code:400
LimitExceeded 割り当てリソースをすでに超えている。 HTTP Status Code:400

DescribeTags - タグ設定を表示する

概要
AutoScalingグループに設定されているタグ情報を一覧で取得するAPIです。

最大取得件数の指定により、件数超過で取得できなかったタグ情報が存在する場合は、
NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、件数を超過した続きからタグ情報を取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeTags」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
Filters.member.N フィルター(タグの属性により内容の絞り込みを行う)のリストを指定します。 No Filter list
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
NextToken 次回開始位置  
Tags タグリスト Key,PropagateAtLaunch, ResourceId,ResourceType, Value
Key タグのキー名  
PropagateAtLaunch インスタンス起動時タグ適用。Trueの場合、タグが設定されたAutoScaling グループ内でVMを新たに生成した際、そのVMに対してもタグを付与します。  
ResourceId AutoScalingグループ名  
ResourceType リソース種別。AutoScalingグループの場合、 ”auto-scaling-group”を指定します。  
Value タグの値  
サンプルレスポンス
<DescribeTagsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <DescribeTagsResult>
  <Tags>
   <member>
    <ResourceId>test-auto-scaling-group</ResourceId>
    <PropagateAtLaunch>true</PropagateAtLaunch>
    <Value>Value</Value>
    <Key>Key</Key>
    <ResourceType>auto-scaling-group</ResourceType>
   </member>
  </Tags>
 </DescribeTagsResult>
 <ResponseMetadata>
  <RequestId>8ac0b051-5fad-cc58-ec9b-2a5872cbcb82</RequestId>
 </ResponseMetadata>
</DescribeTagsResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

DeleteTags - タグ設定を削除する

概要
登録したタグ設定を削除するAPIです。
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DeleteTags」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
Tags.member.N タグをリスト形式で指定します。 Yes Tag list
サンプルレスポンス
<DeleteTagsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
  <RequestId>4daa9188-893f-a88b-200e-0d886d9297f4</RequestId>
 </ResponseMetadata>
</DeleteTagsResponse>

2.6. ポリシー管理

AutoScalingグループに対するポリシーを 管理するためのAPIコマンドです。

DeletePolicy - ポリシーを削除する

概要
AutoScalingグループに設定されたポリシーを削除するAPIです。
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DeletePolicy」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 No String
PolicyName ポリシー名 Yes String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=DeletePolicy \
 PolicyName=PolicyDemo \
サンプルレスポンス
<DeletePolicyResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>d784d6fc-44c0-f571-f2b1-440fd301fb2d</RequestId>
 </ResponseMetadata>
</DeletePolicyResponse>

DescribeAdjustmentTypes - 調整種別の表示

概要
PutScalingPolicyで利用可能な調整種別を表示します。
調整種別は、スケーリングポリシーの実行時、どのようにVMの台数を増減させるかを示します。以下の調整種別が利用可能です。
・”ChangeInCapacity” : 現在のVM台数から、指定した数のVMを増減させるポリシーです。
・”ExactCapacity” : 指定した数にVM台数を設定するポリシーです。
・”PercentChangeInCapacity” : 現在のVM台数から、パーセント比率でVM台数を増減させるポリシーです。増減後のVM台数が整数値でない場合、値は切り捨てになります。(例:現在のVM台数が10台のときに、VM台数の調整値を20にすると、10台のうち20パーセントである2台分VMが増加し、合計数は12台になります。)
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeAdjustmentTypes」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
なし      
レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
AdjustmentTypes 調整種別リスト AdjustmentType
AdjustmentType
調整種別名。以下の項目から選択することができます。
・”ChangeInCapacity” : 現在のVM台数から、 指定した数のVMを増減させるポリシーです。 ・”ExactCapacity” : 指定した数にVM台数を設定するポリシーです。 ・”PercentChangeInCapacity” : 現在のVM台数から、パーセント比率で VM台数を増減させるポリシーです。増減後のVM台数が整数値でない場合、 値は切り捨てになります。(例:現在のVM台数が10台のときに、VM台数の 調整値を20にすると、10台のうち20パーセントである2台分VMが増加し、 合計数は12台になります。)
 

DescribePolicies - ポリシー一覧を表示する

概要
AutoScalingグループに割り当てられたスケーリングポリシーを表示します。
AutoScalingグループを指定しない場合、すべてのスケーリングポリシーが表示されます。
最大取得件数の指定により、件数超過で取得できなかったスケーリングポリシーが存在する場合は、
NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、件数を超過した続きからスケーリングポリシーを取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribePolicies」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名リスト No String
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
PolicyNames.member.N ポリシー名リスト No String list
サンプルAPIコール&レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
NextToken 次回開始位置  
ScalingPolicies ポリシーリスト AdjustmentType,Alarms, AutoScalingGroupName,Cooldown, MinAdjustmentStep,PolicyARN, PolicyName,ScalingAdjustment
AdjustmentType
調整種別。以下のポリシーから選択することができます。
“ChangeInCapacity”:現在のVM台数から、 指定した数のVMを増減させるポリシーです。 “ExactCapacity”:指定した数にVM台数を設定するポリシーです。 “PercentChangeInCapacity”:現在のVM台数から、 パーセント比率でVM台数を増減させるポリシーです。 増減後のVM台数が整数値でない場合、値は切り捨てになります。 (例:現在のVM台数が10台のときに、VM台数の調整値を20にすると、 10台のうち20パーセントである2台分VMが増加し合計数は12台になります。)
 
Alarms アラームリスト。スケーリングポリシーを、 Monitoringに設定されたアラーム起因で実行する場合、表示されます。  
AutoScalingGroupName AutoScalingグループ名  
Cooldown クールダウン時間。このポリシーによるスケーリング処理が終了し、 次のスケーリング処理を開始可能にするまでの時間を表します。  
MinAdjustmentStep 希望インスタンス数の調整値。 AdjustmentTypeにPercentChangeInCapacityを指定しているときのみ有効です。 スケーリングするVMの台数がMinAdjustmentStepに指定された数を 下回った場合に、スケーリングするVM台数を MinAdjustmentStepに指定された数と同数にします。  
PolicyARN ポリシーARN。ポリシーに対し一意な名称が付与されます。  
PolicyName ポリシー名  
ScalingAdjustment 調整値。スケーリングするVMの台数を表します。増加させるときは正の数、 減少させる際は負の数を表します。  
サンプルAPIコール
$ruby kick_api.rb Action=DescribePolicies  \
サンプルレスポンス
<DescribePoliciesResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <DescribePoliciesResult>
   <ScalingPolicies/>
 </DescribePoliciesResult>
 <ResponseMetadata>
   <RequestId>eae6c3ea-b43b-d262-eb8e-ebff01cbd814</RequestId>
 </ResponseMetadata>
</DescribePoliciesResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

ExecutePolicy - ポリシーを実行する

概要
特定のスケーリングポリシーを実行します。
事前にPutScalingPolicyを実行し、スケーリングポリシーを作成する必要があります。
リクエスト
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
HonorCooldown クールダウン時間優先。Trueを指定すると、AutoScalingグループに設定された クールダウン時間が終了していない場合はエラーになります。 Falseを指定すると、クールダウン時間の終了を待たずにポリシーを実行します。 (デフォルト:False) No Boolean
PolicyName ポリシー名 Yes String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=ExecutePolicy \
 PolicyName=PolicyDemo \
 AutoScalingGroupName=GroupDemo \
サンプルレスポンス
<ExecutePolicyResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <ResponseMetadata>
   <RequestId>a0c9492e-f765-93ce-99dc-818b39546f7f</RequestId>
 </ResponseMetadata>
</ExecutePolicyResponse>

PutScalingPolicy - ポリシーを作成する

概要
スケーリングポリシーを作成、もしくは更新し、AutoScalingグループに割り当てるAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「PutScalingPolicy」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AdjustmentType
調整種別以下のポリシーから選択することができます。
“ChangeInCapacity”:現在のVM台数から、 指定した数のVMを増減させるポリシーです。 “ExactCapacity”:指定した数にVM台数を設定するポリシーです。 “PercentChangeInCapacity”:現在のVM台数から、 パーセント比率でVM台数を増減させるポリシーです。 増減後のVM台数が整数値でない場合、値は切り捨てになります。 (例:現在のVM台数が10台のときに、VM台数の調整値を20にすると、 10台のうち20パーセントである2台分VMが増加し、合計数は12台になります。)
Yes String
AutoScalingGroupName AutoScalingグループ名 Yes String
Cooldown クールダウン時間。このポリシーによるスケーリング処理が終了し、 次のスケーリング処理を開始可能にするまでの時間を指定します。 No Integer
MinAdjustmentStep 希望インスタンス数の調整値。 AdjustmentTypeにPercentChangeInCapacityを指定しているときのみ有効です。 スケーリングするVMの台数がMinAdjustmentStepに指定された数を 下回った場合に、スケーリングするVM台数をMinAdjustmentStepに 指定された数と同数にします。 No Integer
PolicyName ポリシー名(お客様任意の名前) Yes String
ScalingAdjustment 調整値。スケーリングするVMの台数を指定します。 増加させるときは正の数、減少させる際は負の数を指定します。 Yes Integer

注釈

スケールアウト・スケールイル両方利用する場合、 スケールアウト用とスケールイン用の2つのポリシーを作成する必要があります。

サンプルAPIコール&レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
PolicyARN ポリシーARN  
サンプルAPIコール
$ruby kick_api.rb Action=PutScalingPolicy  \
 AdjustmentType=ChangeInCapacity \
 AutoScalingGroupName=GroupDemo \
 PolicyName=PolicyDemo \
 ScalingAdjustment=1
サンプルレスポンス
<PutScalingPolicyResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/">
 <PutScalingPolicyResult>
   <PolicyARN>arn:cloudn:autoscale:jp-e1:cln100098244:scalingPolicy:autoScalingGroupName/GroupDemo:policyName/PolicyDemo</PolicyARN>
 </PutScalingPolicyResult>
 <ResponseMetadata>
   <RequestId>24d3efc3-5842-e42f-1519-eaa0e39a2f3a</RequestId>
 </ResponseMetadata>
</PutScalingPolicyResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
InvalidNextToken NextTokenの値が無効。 HTTP Status Code:400

2.7. スケジュール処理管理

スケジュール処理を管理するためのAPIコマンドです。

DeleteScheduledAction - スケジュール処理設定の削除

概要
特定のスケジュール実行設定を削除するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DeleteScheduledAction」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 No String
ScheduledActionName スケジュール実行名 Yes String

DescribeScheduledActions - 実行されていないスケジュール処理の表示

概要
実行されていないスケジュール処理(スケーリング)を表示します。
AutoScalingグループ名などの指定が無い場合は、すべてのスケジュール処理を表示します。

最大取得件数の指定により、件数超過で取得できなかったスケジュール処理が存在する場合は、
NextTokenがレスポンスとして出力されます。
このNextTokenを入力時に指定することで、件数を超過した続きからスケジュール処理を取得することができます。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「DescribeScheduledActions」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 No String
MaxRecords 最大取得件数 No Integer
NextToken 次回開始位置 No String
ScheduledActionNames.member.N スケジュール実行名リスト No String list
StartTime 開始時刻。ISO8601形式で指定します。 (例:”2014-01-01T09:00:00+09:00” : 日本時間で2014年1月1日午前9時を表します。) No Date Time
レスポンス
レスポンス
レスポンスパラメータ一覧
Node名 説明 子Node
NextToken 次回開始位置  
ScheduledUpdateGroupActions スケジュール実行情報リスト AutoScalingGroupName, DesiredCapacity,MaxSize,MinSize ,ScheduledActionARN, ScheduledActionName,StartTime
AutoScalingGroupName AutoScalingグループ名  
DesiredCapacity 希望インスタンス数。AutoScalingグループに設定するVM台数を指定します。  
MaxSize 最大インスタンス数。AutoScalingグループのVM上限数を更新します。  
MinSize 最小インスタンス数。AutoScalingグループのVM下限数を更新します。  
ScheduledActionARN スケジュール実行名に対して一意に割り当てられる名前を表します。  
ScheduledActionName スケジュール実行名  
StartTime 開始時刻。ISO8601形式で指定します。 (例:”2014-01-01T09:00:00+09:00” : 日本時間で2014年1月1日午前9時を表します。)  

PutScheduledUpdateGroupAction - スケジュール処理設定

概要
AutoScalingグループに対し、指定した時間にスケーリングを行うよう設定するAPIです。
リクエスト
リクエスト
リクエスト
リクエスト  
Request Method GET
Path,Parameters,etc Common Request Parameter 記載のパラメータ及び下記の「リクエストパラメータ」 を指定します。※Actionは、「PutScheduledUpdateGroupAction」を指定します。
Header 無し
Body 無し
リクエストパラメータ一覧
リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AutoScalingGroupName AutoScalingグループ名 Yes String
DesiredCapacity 希望インスタンス数。AutoScalingグループに設定するVM台数を指定します。 No Integer
MaxSize 最大インスタンス数。AutoScalingグループのVM上限数を更新します。 Yes Integer
MinSize 最小インスタンス数。AutoScalingグループのVM下限数を更新します。 Yes Integer
ScheduledActionNames スケジュール実行名 Yes String
StartTime 開始時刻。ISO8601形式で指定します。 (例:”2014-01-01T09:00:00+09:00” : 日本時間で2014年1月1日午前9時を表します。) No Date Time

注釈

以下のAPIはサポート対象外となっております。
・AttachInstances
・DescribeAccountLimits