getScheduledActionList
- Print
- PDF
getScheduledActionList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Summary
Search list of scaling action schedules not executed yet.
You can search the actions already executed through the getAutoScalingActivityLogList action.
Request
Request Parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region code You can decide the region of the Auto Scaling Group where the list of schedules actions will be searched. You can obtain the regionCode through the getRegionList action. Default: Select the first region of the getRegionList search results | |
| autoScalingGroupNo | Yes | String | Auto Scaling Group number autoScalingGroupNo can be obtained through the getAutoScalingGroupList action. | |
| scheduledActionNoList.N | No | List<String> | List of scheduled action numbers You can search by filtering with a scheduled action number. scheduledActionNo can be obtained through the getScheduledActionList action. ex) scheduledActionNoList.1=1234&scheduledActionNoList.2=2345 | |
| scheduledActionNameList.N | No | List<String> | Min : 1, Max : 255 | List of scheduled action names You can search by filtering with a scheduled action name. You can obtain the scheduledActionName through the getScheduledActionList action. ex) scheduledActionNameList.1=test1&scheduledActionNameList.2=test2 |
| startTime | No | Date | yyyy-MM-ddTHH:mm:ssZ | Schedule start date You can search a scheduled action with a start time of startTime or higher. If a scheduledActionNoList or scheduledActionNameList is specified, ignore the current field. format : yyyy-MM-ddTHH:mm:ssZex) 2020-07-25T17:50:00+0900, 2020-07-25T17:50:00+09:00 |
| endTime | No | Date | yyyy-MM-ddTHH:mm:ssZ | Schedule end date You can search a scheduled action with a start time of endTime or lower. If a scheduledActionNoList or scheduledActionNameList is specified, ignore the current field. format : yyyy-MM-ddTHH:mm:ssZex) 2020-07-25T17:50:00+0900, 2020-07-25T17:50:00+09:00 |
| pageNo | No | Integer | Page number of the paged results The results can be paged using pageNo and pageSize. | |
| pageSize | Conditional | Integer | Each page size to be displayed when paging The results can be paged using pageNo and pageSize. You must enter it when entering pageNo. | |
| sortList.N.sortedBy | No | String | Sorted by You can sort the results by the sche name. Options : scheduledActionName ex) sortList.1.sortedBy=scheduledActionName | |
| sortList.N.sortingOrder | No | String | Sorting order When using sortedBy, sort in ascending/descending order. Options: ASC (ascending order) | DESC (descending order) Default : ASC ex) sortList.1.sortingOrder=DESC | |
| responseFormatType | No | String | Format type of the response results Options : xml | json Default : xml |
Response
Response body
Example
Request example
GET {API_URL}/getScheduledActionList
?regionCode=KR
&autoScalingGroupNo=***700
&startTime=2020-12-15T17:00:00+0900
&endTime=2020-12-15T18:00:00+0900
Response example
<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>
Was this article helpful?