updateAutoScalingGroup

Prev Next

VPC環境で利用できます。

Auto Scaling Groupの詳細情報と設定された Launch Configurationを変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /vautoscaling/v2/updateAutoScalingGroup
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Auto Scaling APIで共通して使用されるヘッダの詳細は、Auto Scalingのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
autoScalingGroupNo String Required Auto Scaling Group番号
launchConfigurationNo String Optional Launch Configuration番号
serverNamePrefix String Optional サーバ名の Prefix
  • 英字の小文字、数字、記号の「-」を組み合わせて3~7文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • サーバ名ルール: {Prefix}-{英字|数字}で、Prefixを除く残りは自動作成
minSize Integer Required 最小容量: Auto Scaling Groupの最小サーバ数
  • 0~30
  • maxSize以下に設定
  • サーバを保有しない場合は0を入力
maxSize Integer Required 最大容量: Auto Scaling Groupの最大サーバ数
  • 0~30
  • minSize以上に設定
desiredCapacity Integer Optional 希望する容量: Auto Scaling Groupの希望するサーバ数
  • minSize以上、maxSize以下に設定 (デフォルト: minSizeと同じ)
  • 入力値に応じてサーバ数を自動調整
defaultCoolDown Integer Optional デフォルトのクールダウン(秒)
  • 0~2147483647 (デフォルト: 300)
  • Scaling後にサーバを準備するためのモニタリング待機時間
healthCheckGracePeriod Integer Conditional ヘルスチェックの猶予期間(秒)
  • 0~2147483647 (デフォルト: 300)
  • サーバの初期動作を考慮し、ヘルスチェックに失敗してもサーバを異常と判断しない時間
  • healthCheckTypeCodeがLOADBの場合、必ず入力
healthCheckTypeCode String Optional ヘルスチェックタイプコード
  • SVR (デフォルト) | LOADB
    • SVR: サーバ
    • LOADB: ロードバランサ
  • LOADBの場合、healthCheckGracePeriodは必ず入力
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json
参考

リクエストクエリパラメータの入力時、下記の内容をご確認ください。

  • 入力したリクエストクエリパラメータに対応する情報のみ変更され、入力していないリクエストクエリパラメータに関する情報は既存の値を維持
  • 必須の有無が Optionalのリクエストクエリパラメータを入力しない場合、既存の値がレスポンス結果に表示 (200 OK)
  • minSize、maxSize、desiredCapacityが変更されても、minSize ≤ desiredCapacity ≤ maxSizeの大小関係は有効
  • updateAutoScalingGroup APIの呼び出しで作成された新規 Launch Configurationは、その後に作成されるサーバインスタンス(VM)から反映
  • Scalingが進行中の Auto Scaling Groupに変更をリクエストすると呼び出しは失敗

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/updateAutoScalingGroup
?regionCode=KR
&autoScalingGroupNo=1***9
&maxSize=3
&desiredCapacity=0
&defaultCoolDown=600
&healthCheckGracePeriod=300
&healthCheckTypeCode=LOADB
&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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
updateAutoScalingGroupResponse Object - レスポンス結果
updateAutoScalingGroupResponse.requestId String - リクエスト ID
  • UUID形式
updateAutoScalingGroupResponse.returnCode String - レスポンスコード
updateAutoScalingGroupResponse.returnMessage String - レスポンスメッセージ

レスポンスステータスコード

Auto Scaling APIで共通して使用されるレスポンスステータスコードの詳細は、Auto Scalingのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "updateAutoScalingGroupResponse": {
        "totalRows": 1,
        "autoScalingGroupList": [
            {
                "vpcNo": "4**5",
                "subnetNo": "3***4",
                "serverNamePrefix": "",
                "autoScalingGroupNo": "1***9",
                "autoScalingGroupName": "asg",
                "launchConfigurationNo": "5891",
                "minSize": 0,
                "maxSize": 3,
                "desiredCapacity": 0,
                "defaultCoolDown": 600,
                "healthCheckGracePeriod": 300,
                "healthCheckType": {
                    "code": "LOADB",
                    "codeName": "ロードバランサ"
                },
                "createDate": "2025-05-15T09:50:55+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [],
                "accessControlGroupNoList": [
                    "1***1"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "a8eb0d25-****-****-****-0b05a6829fb9",
        "returnCode": "0",
        "returnMessage": "success"
    }
}