getScheduledActionList

Prev Next

VPC環境で利用できます。

概要

まだ実行されていないScaling Actionのスケジュールリストを照会します。
既に実行されたAction記録はgetAutoScalingActivityLogListアクションを通じて照会できます。

リクエスト

リクエストパラメータ

パラメータ名 必須有無 タイプ 制約事項 説明
regionCode No String リージョンコード
Auto Scaling GroupのScheduled Actionリストが照会されるリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
autoScalingGroupNo Yes String Auto Scaling Group番号
autoScalingGroupNoはgetAutoScalingGroupListアクションを通じて取得できます。
scheduledActionNoList.N No List<String> Scheduled Action番号リスト
Scheduled Action番号でフィルタリングして検索できます。
scheduledActionNoはgetScheduledActionListアクションを通じて取得できます。
ex) scheduledActionNoList.1=1234&scheduledActionNoList.2=2345
scheduledActionNameList.N No List<String> Min : 1, Max : 255 Scheduled Action名リスト
Scheduled Action名でフィルタリングして検索できます。
scheduledActionNameはgetScheduledActionListアクションを通じて取得できます。
ex) scheduledActionNameList.1=test1&scheduledActionNameList.2=test2
startTime No Date yyyy-MM-ddTHH:mm:ssZ スケジュール開始日時
開始日時がstartTime以上のScheduled Actionを照会できます。
scheduledActionNoListまたはscheduledActionNameListが明示されている場合、現在のフィールドを無視します。
format : yyyy-MM-ddTHH:mm:ssZ
ex) 2020-07-25T17:50:00+0900, 2020-07-25T17:50:00+09:00
endTime No Date yyyy-MM-ddTHH:mm:ssZ スケジュールの終了日時
終了日時がendTime以下のScheduled Actionを照会できます。
scheduledActionNoListまたはscheduledActionNameListが明示されている場合、現在のフィールドを無視します。
format : yyyy-MM-ddTHH:mm:ssZ
ex) 2020-07-25T17:50:00+0900, 2020-07-25T17:50:00+09:00
pageNo No Integer ページングされた結果のページ番号
結果値をpageNo、pageSizeを用いてページング処理することができます。
pageSize Conditional Integer ページングする時に表示する各ページサイズ
結果値をpageNo、pageSizeを用いてページング処理することができます。
pageNoを入力する時、必ず入力します。
sortList.N.sortedBy No String ソート対象
結果値をScheduled Action名でソートできます。
Options : scheduledActionName
ex) sortList.1.sortedBy=scheduledActionName
sortList.N.sortingOrder No String ソート順序
sortedByを利用する時、昇順/降順ソートを設定します。
Options：ASC (昇順) | DESC (降順)
Default : ASC
ex) sortList.1.sortingOrder=DESC
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータのタイプ

  • ScheduledUpdateGroupActionListタイプ
ScheduledUpdateGroupActionList extends CommonResponse
private Integer totalRows;
private List scheduledUpdateGroupActionList = new ArrayList<>();
ScheduledUpdateGroupAction
private String autoScalingGroupNo;
private String scheduledActionNo;
private String scheduledActionName;
private Integer minSize;
private Integer maxSize;
private Integer desiredCapacity;
private Date startTime;
private Date endTime;
private String recurrence;
private String timeZone;

例

リクエスト例

ncloud vautoscaling getScheduledActionList --regionCode KR --autoScalingGroupNo ***700 --startTime "2020-12-15T17:00:00+0900" --endTime "2020-12-15T18:00:00+0900"

レスポンス例

<getScheduledActionListResponse>
  <requestId>cc4084f6-f32c-4894-b2b8-430982320159</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <scheduledUpdateGroupActionList>
    <scheduledUpdateGroupAction>
      <autoScalingGroupNo>***700</autoScalingGroupNo>
      <scheduledActionNo>***281</scheduledActionNo>
      <scheduledActionName>test-***</scheduledActionName>
      <minSize>0</minSize>
      <maxSize>0</maxSize>
      <desiredCapacity>0</desiredCapacity>
      <startTime>2020-12-15T17:05:00+0900</startTime>
      <endTime>2020-12-15T18:00:00+0900</endTime>
      <recurrence>5 * * * *</recurrence>
      <timeZone>KST</timeZone>
    </scheduledUpdateGroupAction>
  </scheduledUpdateGroupActionList>
</getScheduledActionListResponse>