Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-scheduled-instance-availability

Описание

Находит доступные расписания, соответствующие заданным критериям.

Вы можете искать доступное расписание не более чем за 3 месяца вперёд. Необходимо соблюдать минимальную требуемую продолжительность 1200 часов в год. Например, минимальное ежедневное расписание составляет 4 часа, минимальное еженедельное расписание — 24 часа, а минимальное ежемесячное расписание — 100 часов.

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

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

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

Синтаксис

  describe-scheduled-instance-availability
[--dry-run | --no-dry-run]
[--filters <value>]
--first-slot-start-time-range <value>
[--max-slot-duration-in-hours <value>]
[--min-slot-duration-in-hours <value>]
--recurrence <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет, имеете ли вы необходимые разрешения для действия, не выполняя сам запрос, и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке будет DryRunOperation. В противном случае, это UnauthorizedOperation.

--filters (список)

Фильтры.

  • availability-zone - Зона доступности (например, us-west-2a).
  • instance-type - Тип экземпляра (например, c4.large).
  • platform - Платформа (Linux/UNIX или Windows).

(структура)

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

Если вы указываете несколько фильтров, фильтры объединяются с помощью AND, и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.

Для получения дополнительной информации см. Раздел Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью OR, и запрос возвращает все результаты, соответствующие любому из указанных значений.

(строка)

Краткая форма синтаксиса:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--first-slot-start-time-range (структура)

Период времени для начала первого расписания.

НачальнаяДатаВремя -> (метка времени)

Самая ранняя дата и время (в UTC) начала запланированного экземпляра.

КонечнаяДатаВремя -> (метка времени)

Самая поздняя дата и время (в UTC) начала запланированного экземпляра. Это значение должно быть позже или равно начальной дате и не более чем через три месяца.

Краткая форма синтаксиса:

EarliestTime=timestamp,LatestTime=timestamp

Синтаксис JSON:

{
  "EarliestTime": timestamp,
  "LatestTime": timestamp
}

--max-slot-duration-in-hours (целое число)

Максимальная доступная продолжительность в часах. Это значение должно быть больше MinSlotDurationInHours и меньше 1720.

--min-slot-duration-in-hours (целое число)

Минимальная доступная продолжительность в часах. Минимальная требуемая продолжительность составляет 1200 часов в год. Например, минимальное ежедневное расписание составляет 4 часа, минимальное еженедельное расписание — 24 часа, а минимальное ежемесячное расписание — 100 часов.

--recurrence (структура)

Повторное расписание.

Частота -> (строка)

Частота (Daily, Weekly или Monthly).

Интервал -> (целое число)

Количество интервалов. Единица интервала зависит от значения Frequency. Например, каждые 2 недели или каждые 2 месяца.

Дни -> (список)

Дни. Для ежемесячного расписания это один или несколько дней месяца (1-31). Для еженедельного расписания это один или несколько дней недели (1-7, где 1 — воскресенье). Вы не можете указать это значение для ежедневного расписания. Если повторяемость относится к концу месяца, вы можете указать только один день.

(целое число)

ОтносительноКонца -> (boolean)

Указывает, относится ли повторяемость к концу указанной недели или месяца. Вы не можете указать это значение для ежедневного расписания.

Единица -> (строка)

Единица для OccurrenceDays (DayOfWeek или DayOfMonth). Это значение обязательно для ежемесячного расписания. Вы не можете указать DayOfWeek для еженедельного расписания. Вы не можете указать это значение для ежедневного расписания.

Краткая форма синтаксиса:

Frequency=string,Interval=integer,OccurrenceDays=integer,integer,OccurrenceRelativeToEnd=boolean,OccurrenceUnit=string

Синтаксис JSON:

{
  "Frequency": "string",
  "Interval": integer,
  "OccurrenceDays": [integer, ...],
  "OccurrenceRelativeToEnd": true|false,
  "OccurrenceUnit": "string"
}

--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 (boolean)

Включить отладку.

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

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (строка)

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

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--no-sign-request (boolean)

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

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

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 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 (boolean)

Отключить кли-постраничник для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для описания доступного графика

В этом примере описывается график, который происходит каждую неделю по воскресеньям, начиная со указанной даты.

Команда:

aws ec2 describe-scheduled-instance-availability --recurrence Frequency=Weekly,Interval=1,OccurrenceDays=[1] --first-slot-start-time-range EarliestTime=2016-01-31T00:00:00Z,LatestTime=2016-01-31T04:00:00Z

Вывод:

{
  "ScheduledInstanceAvailabilitySet": [
    {
        "AvailabilityZone": "us-west-2b",
        "TotalScheduledInstanceHours": 1219,
        "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...",
        "MinTermDurationInDays": 366,
        "AvailableInstanceCount": 20,
        "Recurrence": {
            "OccurrenceDaySet": [
                1
            ],
            "Interval": 1,
            "Frequency": "Weekly",
            "OccurrenceRelativeToEnd": false
        },
        "Platform": "Linux/UNIX",
        "FirstSlotStartTime": "2016-01-31T00:00:00Z",
        "MaxTermDurationInDays": 366,
        "SlotDurationInHours": 23,
        "NetworkPlatform": "EC2-VPC",
        "InstanceType": "c4.large",
        "HourlyPrice": "0.095"
    },
    ...
  ]
}

Для сужения результатов можно добавить фильтры, которые указывают операционную систему, сеть и тип экземпляра.

Команда:

–filters Name=platform,Values=Linux/UNIX Name=network-platform,Values=EC2-VPC Name=instance-type,Values=c4.large

Вывод

NextToken -> (строка)

Токен, необходимый для получения следующего набора результатов. Это значение равно null, если больше результатов нет.

ScheduledInstanceAvailabilitySet -> (список)

Информация о доступных запланированных экземплярах.

(структура)

Описание графика, доступного для ваших запланированных экземпляров.

AvailabilityZone -> (строка)

Доступная зона.

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

Количество доступных экземпляров.

FirstSlotStartTime -> (метка времени)

Период времени для начала первого графика.

HourlyPrice -> (строка)

Часовая стоимость одного экземпляра.

InstanceType -> (строка)

Тип экземпляра. Вы можете указать один из типов экземпляров C3, C4, M4 или R3.

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

Максимальный срок. Единственное возможное значение — 365 дней.

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

Минимальный срок. Единственное возможное значение — 365 дней.

NetworkPlatform -> (строка)

Платформа сети.

Platform -> (строка)

Платформа (Linux/UNIX или Windows).

PurchaseToken -> (строка)

Токен покупки. Этот токен истекает через два часа.

Recurrence -> (структура)

Повторение графика.

Frequency -> (строка)

Частота (Daily, Weekly или Monthly).

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

Количество интервала. Единица интервала зависит от значения frequency. Например, каждые 2 недели или каждые 2 месяца.

OccurrenceDaySet -> (список)

Дни. Для ежемесячного графика это один или несколько дней месяца (1-31). Для еженедельного графика это один или несколько дней недели (1-7, где 1 — воскресенье).

(целое число)

OccurrenceRelativeToEnd -> (булево)

Указывает, является ли появление относительным к концу указанной недели или месяца.

OccurrenceUnit -> (строка)

Единица для occurrenceDaySet (DayOfWeek или DayOfMonth).

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

Количество часов в графике.

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

Общее количество часов для одного экземпляра за весь срок.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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