Spec-Zone.ru › AWS CLI v2

[ aws . autoscaling ]

describe-scheduled-actions

Описание

Получает информацию о запланированных действиях, которые ещё не были выполнены или не достигли своего конечного времени.

Чтобы описать действия масштабирования для запланированных действий, которые уже были выполнены, вызовите API DescribeScalingActivities.

См. также: Документация API AWS

describe-scheduled-actions является посторінкованной операцией. Для получения всего набора результатов могут быть выпущены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ScheduledUpdateGroupActions

Синтаксис

  describe-scheduled-actions
[--auto-scaling-group-name <value>]
[--scheduled-action-names <value>]
[--start-time <value>]
[--end-time <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--auto-scaling-group-name (строка)

Название группы Auto Scaling.

--scheduled-action-names (список)

Имена одного или нескольких запланированных действий. Если этот параметр опущен, описываются все запланированные действия. Если вы укажете неизвестное запланированное действие, оно будет проигнорировано без ошибки.

Элементы массива: максимальное количество 50 действий.

(строка)

Синтаксис:

"string" "string" ...

--start-time (метка времени)

Самое раннее время начала запланированного действия для возврата. Если указаны имена запланированных действий, этот параметр игнорируется.

--end-time (метка времени)

Самое позднее время начала запланированного действия для возврата. Если указаны имена запланированных действий, этот параметр игнорируется.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания начала постраничного вывода. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включает отладку.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключает автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с сертификатом CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного параметра cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключение постраничного вывода cli для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивает параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключение автоматического запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования типа Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. Подробнее см. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1: Описание всех запланированных действий

В этом примере описываются все ваши запланированные действия.

aws autoscaling describe-scheduled-actions

Вывод:

{
    "ScheduledUpdateGroupActions": [
        {
            "AutoScalingGroupName": "my-asg",
            "ScheduledActionName": "my-recurring-action",
            "Recurrence": "30 0 1 1,6,12 *",
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
            "StartTime": "2023-12-01T04:00:00Z",
            "Time": "2023-12-01T04:00:00Z",
            "MinSize": 1,
            "MaxSize": 6,
            "DesiredCapacity": 4,
            "TimeZone": "America/New_York"
        }
    ]
}

Дополнительную информацию см. в разделе Запланированное масштабирование в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 2: Описание запланированных действий для указанной группы

Чтобы описать запланированные действия для конкретной группы Auto Scaling, используйте параметр --auto-scaling-group-name.

aws autoscaling describe-scheduled-actions \
    --auto-scaling-group-name my-asg

Вывод:

{
    "ScheduledUpdateGroupActions": [
        {
            "AutoScalingGroupName": "my-asg",
            "ScheduledActionName": "my-recurring-action",
            "Recurrence": "30 0 1 1,6,12 *",
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
            "StartTime": "2023-12-01T04:00:00Z",
            "Time": "2023-12-01T04:00:00Z",
            "MinSize": 1,
            "MaxSize": 6,
            "DesiredCapacity": 4,
            "TimeZone": "America/New_York"
        }
    ]
}

Дополнительную информацию см. в разделе Запланированное масштабирование в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 3: Описание указанного запланированного действия

Чтобы описать конкретное запланированное действие, используйте параметр --scheduled-action-names.

aws autoscaling describe-scheduled-actions \
    --scheduled-action-names my-recurring-action

Вывод:

{
    "ScheduledUpdateGroupActions": [
        {
            "AutoScalingGroupName": "my-asg",
            "ScheduledActionName": "my-recurring-action",
            "Recurrence": "30 0 1 1,6,12 *",
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
            "StartTime": "2023-12-01T04:00:00Z",
            "Time": "2023-12-01T04:00:00Z",
            "MinSize": 1,
            "MaxSize": 6,
            "DesiredCapacity": 4,
            "TimeZone": "America/New_York"
        }
    ]
}

Дополнительную информацию см. в разделе Запланированное масштабирование в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 4: Описание запланированных действий с указанным временем начала

Чтобы описать запланированные действия, которые начинаются в определённое время, используйте параметр --start-time.

aws autoscaling describe-scheduled-actions \
    --start-time "2023-12-01T04:00:00Z"

Вывод:

{
    "ScheduledUpdateGroupActions": [
        {
            "AutoScalingGroupName": "my-asg",
            "ScheduledActionName": "my-recurring-action",
            "Recurrence": "30 0 1 1,6,12 *",
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
            "StartTime": "2023-12-01T04:00:00Z",
            "Time": "2023-12-01T04:00:00Z",
            "MinSize": 1,
            "MaxSize": 6,
            "DesiredCapacity": 4,
            "TimeZone": "America/New_York"
        }
    ]
}

Дополнительную информацию см. в разделе Запланированное масштабирование в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 5: Описание запланированных действий, которые заканчиваются в указанное время

Чтобы описать запланированные действия, которые заканчиваются в определённое время, используйте параметр --end-time.

aws autoscaling describe-scheduled-actions \
    --end-time "2023-12-01T04:00:00Z"

Вывод:

{
    "ScheduledUpdateGroupActions": [
        {
            "AutoScalingGroupName": "my-asg",
            "ScheduledActionName": "my-recurring-action",
            "Recurrence": "30 0 1 1,6,12 *",
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
            "StartTime": "2023-12-01T04:00:00Z",
            "Time": "2023-12-01T04:00:00Z",
            "MinSize": 1,
            "MaxSize": 6,
            "DesiredCapacity": 4,
            "TimeZone": "America/New_York"
        }
    ]
}

Дополнительную информацию см. в разделе Запланированное масштабирование в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 6: Описание указанного количества запланированных действий

Чтобы вернуть определённое количество запланированных действий, используйте параметр --max-items.

aws autoscaling describe-scheduled-actions \
    --auto-scaling-group-name my-asg \
    --max-items 1

Вывод:

{
    "ScheduledUpdateGroupActions": [
        {
            "AutoScalingGroupName": "my-asg",
            "ScheduledActionName": "my-recurring-action",
            "Recurrence": "30 0 1 1,6,12 *",
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
            "StartTime": "2023-12-01T04:00:00Z",
            "Time": "2023-12-01T04:00:00Z",
            "MinSize": 1,
            "MaxSize": 6,
            "DesiredCapacity": 4,
            "TimeZone": "America/New_York"
        }
    ]
}

Если вывод содержит поле NextToken, запланированных действий больше. Чтобы получить дополнительные запланированные действия, используйте значение этого поля с параметром --starting-token в последующем вызове следующим образом.

aws autoscaling describe-scheduled-actions \
    --auto-scaling-group-name my-asg \
    --starting-token Z3M3LMPEXAMPLE

Дополнительную информацию см. в разделе Запланированное масштабирование в Руководстве пользователя Amazon EC2 Auto Scaling.

Вывод

ScheduledUpdateGroupActions -> (список)

Расписанные действия.

(структура)

Описывает расписанное действие масштабирования.

AutoScalingGroupName -> (строка)

Имя группы автоматического масштабирования.

ScheduledActionName -> (строка)

Имя расписанного действия.

ScheduledActionARN -> (строка)

Amazon Resource Name (ARN) расписанного действия.

Time -> (временная метка)

Это свойство больше не используется.

StartTime -> (временная метка)

Дата и время в UTC для начала этого действия. Например, "2019-06-01T00:00:00Z" .

EndTime -> (временная метка)

Дата и время в UTC для окончания повторяющегося расписания. Например, "2019-06-01T00:00:00Z" .

Recurrence -> (строка)

Повторяющееся расписание для действия в формате синтаксиса cron Unix.

Когда StartTime и EndTime указаны с Recurrence , они образуют границы, когда повторяющееся действие начинается и заканчивается.

MinSize -> (целое число)

Минимальный размер группы автоматического масштабирования.

MaxSize -> (целое число)

Максимальный размер группы автоматического масштабирования.

DesiredCapacity -> (целое число)

Желаемая емкость — это начальная емкость группы автоматического масштабирования после выполнения расписанного действия и емкость, которую она пытается поддерживать.

TimeZone -> (строка)

Часовой пояс для выражения cron.

NextToken -> (строка)

Строка, которая указывает, что ответ содержит больше элементов, чем может быть возвращено в одном ответе. Чтобы получить дополнительные элементы, укажите эту строку для значения NextToken при запросе следующего набора элементов. Это значение равно null, когда больше элементов возвращать не нужно.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API