Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-volumes-modifications

Описание

Описывает последний запрос изменения характеристик для указанных томов EBS.

Дополнительную информацию см. в разделе «Отслеживание хода изменения характеристик томов» в руководстве пользователя Amazon EBS.

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

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

Синтаксис

  describe-volumes-modifications
[--dry-run | --no-dry-run]
[--volume-ids <value>]
[--filters <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.

--volume-ids (список)

Идентификаторы томов.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Фильтры.

  • modification-state - Текущее состояние изменения (modifying | optimizing | completed | failed).
  • original-iops - Исходная скорость IOPS тома.
  • original-size - Исходный размер тома в GiB.
  • original-volume-type - Исходный тип тома (standard | io1 | io2 | gp2 | sc1 | st1).
  • originalMultiAttachEnabled - Указание, было ли включено Multi-Attach (true | false).
  • start-time - Время начала изменения.
  • target-iops - Целевая скорость IOPS тома.
  • target-size - Целевой размер тома в GiB.
  • target-volume-type - Целевой тип тома (standard | io1 | io2 | gp2 | sc1 | st1).
  • targetMultiAttachEnabled - Указание, включить ли Multi-Attach (true | false).
  • volume-id - Идентификатор тома.

(структура)

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

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

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

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

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

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

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

(строка)

Сокращенный синтаксис:

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

Синтаксис JSON:

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

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

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

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

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя AWS CLI.

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

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

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя AWS CLI.

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

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

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя AWS CLI.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Для описания состояния изменения тома

Следующий describe-volumes-modifications пример описывает состояние изменения тома указанного тома.

aws ec2 describe-volumes-modifications \
    --volume-ids vol-1234567890abcdef0

Вывод:

{
    "VolumeModification": {
        "TargetSize": 150,
        "TargetVolumeType": "io1",
        "ModificationState": "optimizing",
        "VolumeId": " vol-1234567890abcdef0",
        "TargetIops": 100,
        "StartTime": "2019-05-17T11:27:19.000Z",
        "Progress": 70,
        "OriginalVolumeType": "io1",
        "OriginalIops": 100,
        "OriginalSize": 100
    }
}

Выходные данные

NextToken -> (строка)

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

VolumesModifications -> (список)

Информация о модификациях томов.

(структура)

Описание состояния модификации тома EBS.

VolumeId -> (строка)

Идентификатор тома.

ModificationState -> (строка)

Текущее состояние модификации.

StatusMessage -> (строка)

Сообщение о статусе прогресса или ошибке модификации.

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

Целевой размер тома в GiB.

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

Целевая скорость IOPS тома.

TargetVolumeType -> (строка)

Целевой тип тома EBS.

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

Целевой пропускная способность тома в MiB/с.

TargetMultiAttachEnabled -> (булево)

Целевое значение для Amazon EBS Multi-Attach.

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

Исходный размер тома в GiB.

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

Исходная скорость IOPS тома.

OriginalVolumeType -> (строка)

Исходный тип тома EBS.

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

Исходная пропускная способность тома в MiB/с.

OriginalMultiAttachEnabled -> (булево)

Исходное значение для Amazon EBS Multi-Attach.

Progress -> (длинное целое число)

Прогресс модификации, от 0 до 100 процентов.

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

Время начала модификации.

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

Время завершения или ошибки модификации.

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

Spec-Zone.ru

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