putScalingPolicy

VPC環境で利用できます。

Auto Scaling Groupの Scalingポリシーを作成したり変更したりします。

リクエスト

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

メソッド	URI
GET \| POST	/vautoscaling/v2/putScalingPolicy

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`autoScalingGroupNo`	String	Required	Auto Scaling Group番号 getAutoScalingGroupListを参照
`policyNo`	String	Conditional	ポリシー番号 getAutoScalingPolicyListを参照ポリシー作成時、入力しないポリシー変更時、`policyNo`、`policyName`のうち、いずれか1つは必ず入力
`policyName`	String	Conditional	ポリシー名新しい名前を入力するとポリシーを作成英字の小文字、数字、記号の「-」を使用して1~255文字以内で入力文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用既存の名前を入力するとポリシーを変更ポリシー名: getAutoScalingPolicyListを参照ポリシー作成時、必ず入力ポリシー変更時、`policyNo`、`policyName`のうち、いずれか1つは必ず入力
`adjustmentTypeCode`	String	Required	調整タイプコード getAdjustmentTypeListを参照
`scalingAdjustment`	Integer	Required	調整値調整タイプに応じて指定 `CHANG`: -2147483648以上 `PRCNT`: -100以上 `EXACT`: 0以上最大2147483647まで入力可能 `CHANG`/`PRCNT`の場合、負の数を入力すると減少
`minAdjustmentStep`	Integer	Optional	最小調整幅 1~2147483647 最小調整幅の分だけサーバインスタンス数を変更 `adjustmentTypeCode`が`PRCNT`の場合にのみ有効
`coolDown`	Integer	Optional	クールダウン(秒) 0~2147483647 (デフォルト: 300) Scaling後にサーバを準備するためのモニタリング待機時間
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/putScalingPolicy
?regionCode=KR
&autoScalingGroupNo=1***9
&policyName=pol1
&adjustmentTypeCode=CHANG
&scalingAdjustment=1
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "putScalingPolicyResponse": {
        "totalRows": 1,
        "scalingPolicyList": [
            {
                "autoScalingGroupNo": "1***9",
                "policyNo": "3426",
                "policyName": "pol1",
                "adjustmentType": {
                    "code": "CHANG",
                    "codeName": "容量変更値"
                },
                "scalingAdjustment": 1,
                "coolDown": 300
            }
        ],
        "requestId": "ab7a4a24-****-****-****-c8b9bdf91c40",
        "returnCode": "0",
        "returnMessage": "success"
    }
}