getScheduledActionList

VPC環境で利用できます。

Auto Scaling Groupの Scalingスケジュールのうち、まだ実行されていないスケジュールリストを照会します。

参考

既に実行済みスケジュールを照会する方法は、getAutoScalingActivityLogListをご参照ください。

リクエスト

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

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

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`autoScalingGroupNo`	String	Required	Auto Scaling Group番号 getAutoScalingGroupListを参照
`scheduledActionNoList.N`	Array	Optional	スケジュール番号リストスケジュール番号で絞り込み <例> `scheduledActionNoList.1=1234&scheduledActionNoList.2=2345`
`scheduledActionNameList.N`	Array	Optional	スケジュール名リストスケジュール名で絞り込み <例> `scheduledActionNameList.1=test1&scheduledActionNameList.2=test2`
`startTime`	Date	Optional	スケジュール開始日時 yyyy-MM-ddTHH:mm:ssZ形式入力時刻以降のスケジュールを照会 `scheduledActionNoList`または`scheduledActionNameList`を指定する場合、無視 <例> `2020-07-25T17:50:00+0900` (URLエンコードが必要)
`endTime`	Date	Optional	スケジュール終了日時 yyyy-MM-ddTHH:mm:ssZ形式入力時刻以前のスケジュールを照会 `scheduledActionNoList`または`scheduledActionNameList`を指定する場合、無視 <例> `2020-07-25T17:50:00+0900` (URLエンコードが必要)
`pageNo`	Integer	Optional	ページ番号 1~N
`pageSize`	Integer	Conditional	ページごとの項目数 1~N `pageNo`入力時、必ず入力
`sortList.N.sortedBy`	String	Optional	ソート対象 `scheduledActionName`: スケジュール名 (有効値) <例> `sortList.1.sortedBy=scheduledActionName`
`sortList.N.sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/getScheduledActionList
?regionCode=KR
&autoScalingGroupNo=1***9
&startTime=2025-06-13T00%3A00%3A00%2B0900
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getScheduledActionListResponse": {
        "totalRows": 2,
        "scheduledUpdateGroupActionList": [
            {
                "autoScalingGroupNo": "1***9",
                "scheduledActionNo": "1183",
                "scheduledActionName": "sch2",
                "minSize": 0,
                "maxSize": 0,
                "desiredCapacity": 0,
                "startTime": "2025-06-14T17:50:00+0900",
                "endTime": "2025-06-14T18:10:00+0900",
                "recurrence": "",
                "timeZone": "KST"
            },
            {
                "autoScalingGroupNo": "1***9",
                "scheduledActionNo": "1182",
                "scheduledActionName": "sch1",
                "minSize": 0,
                "maxSize": 2,
                "desiredCapacity": 0,
                "startTime": "2025-06-15T17:50:00+0900",
                "endTime": "2025-06-15T18:10:00+0900",
                "recurrence": "",
                "timeZone": "KST"
            }
        ],
        "requestId": "b91ffd88-****-****-****-4d9c735262c4",
        "returnCode": "0",
        "returnMessage": "success"
    }
}