VPC環境で利用できます。
Auto Scaling Groupを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vautoscaling/v2/createAutoScalingGroup |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Auto Scaling APIで共通して使用されるヘッダの詳細は、Auto Scalingのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | リージョンコード
|
launchConfigurationNo |
String | Required | Launch Configuration番号
|
autoScalingGroupName |
String | Optional | Auto Scaling Group名
|
vpcNo |
String | Required | VPC番号
|
subnetNo |
String | Required | Subnet番号 |
accessControlGroupNoList.N |
Array | Required | ACG番号リスト
|
serverNamePrefix |
String | Optional | サーバ名の Prefix
|
minSize |
Integer | Required | 最小容量: Auto Scaling Groupの最小サーバ数
|
maxSize |
Integer | Required | 最大容量: Auto Scaling Groupの最大サーバ数
|
desiredCapacity |
Integer | Optional | 希望する容量: Auto Scaling Groupの希望するサーバ数
|
defaultCoolDown |
Integer | Optional | デフォルトのクールダウン(秒)
|
healthCheckGracePeriod |
Integer | Conditional | ヘルスチェックの猶予期間(秒)
|
healthCheckTypeCode |
String | Optional | ヘルスチェックタイプコード
|
targetGroupNoList.N |
Array | Optional | Target Group番号リスト
|
responseFormatType |
String | Optional | レスポンスデータの形式
|
参考
リクエストクエリパラメータの入力時、下記の内容をご確認ください。
defaultCoolDown: 新しいサーバが作成されたとしても、初期化スクリプトの実行やアップデートのインストールなどの理由で実際のサービスを実行できるように準備が整うまでは時間がかかります。これを考慮し、実際に Scalingが実行中か、実行完了した後にモニタリングイベントアラームが発生しても反応せず無視させるように設定した期間をクールダウン(Cooldown)時間と定義します。healthCheckGracePeriod: サーバが作成されて「運用中」に変わったとしても、サーバアップデートのインストールなどの動作により、ヘルスチェックに正常に応答できない場合があります。これを考慮し、ヘルスチェックに失敗してもサーバに異常がないと判断する、ヘルスチェック猶予期間を設定することができます。
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/createAutoScalingGroup
?regionCode=KR
&launchConfigurationNo=5891
&vpcNo=4**5
&subnetNo=3***4
&accessControlGroupNoList.1=1***1
&minSize=0
&maxSize=1
&desiredCapacity=0
&healthCheckTypeCode=SVR
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
createAutoScalingGroupResponse |
Object | - | レスポンス結果 |
createAutoScalingGroupResponse.requestId |
String | - | リクエスト ID
|
createAutoScalingGroupResponse.returnCode |
String | - | レスポンスコード |
createAutoScalingGroupResponse.returnMessage |
String | - | レスポンスメッセージ |
レスポンスステータスコード
Auto Scaling APIで共通して使用されるレスポンスステータスコードの詳細は、Auto Scalingのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"createAutoScalingGroupResponse": {
"totalRows": 1,
"autoScalingGroupList": [
{
"vpcNo": "4**5",
"subnetNo": "3***4",
"serverNamePrefix": "",
"autoScalingGroupNo": "1***1",
"autoScalingGroupName": "as19762e46344",
"launchConfigurationNo": "5891",
"minSize": 0,
"maxSize": 1,
"desiredCapacity": 0,
"defaultCoolDown": 300,
"healthCheckGracePeriod": 300,
"healthCheckType": {
"code": "SVR",
"codeName": "Server"
},
"createDate": "2025-06-12T15:47:04+0900",
"autoScalingGroupStatus": {
"code": "CREAT",
"codeName": "Created"
},
"targetGroupNoList": [],
"inAutoScalingGroupServerInstanceList": [],
"accessControlGroupNoList": [
"1***1"
],
"suspendedProcessList": []
}
],
"requestId": "cb3b0c69-****-****-****-179d71217eea",
"returnCode": "0",
"returnMessage": "success"
}
}