executePolicy

Prev Next

VPC環境で利用できます。

Auto Scaling Groupの Scalingポリシーを実行します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
autoScalingGroupNo String Required Auto Scaling Group番号
policyNo String Required ポリシー番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/executePolicy
?regionCode=KR
&autoScalingGroupNo=1***9
&policyNo=3381
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "executePolicyResponse": {
        "totalRows": 1,
        "scalingPolicyList": [
            {
                "autoScalingGroupNo": "1***9",
                "policyNo": "3381",
                "policyName": "down",
                "adjustmentType": {
                    "code": "CHANG",
                    "codeName": "容量変更値"
                },
                "scalingAdjustment": -1,
                "coolDown": 300
            }
        ],
        "requestId": "86b63e2b-****-****-****-858ad256a488",
        "returnCode": "0",
        "returnMessage": "success"
    }
}