Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-volume-status

Описание

Описывает состояние указанных томов. Состояние тома отражает результаты проверок, выполненных над вашими томами, чтобы определить события, которые могут ухудшить производительность ваших томов. Производительность тома может быть затронута, если возникнет проблема на его базовом узле. Если базовый узел тома испытывает отключение электропитания или системную проблему, после восстановления системы на томе могут возникнуть несоответствия данных. События тома уведомляют вас об этом. Действия тома уведомляют вас о необходимости выполнения каких-либо действий в ответ на событие.

Операция DescribeVolumeStatus предоставляет следующую информацию об указанных томах:

Состояние : отражает текущее состояние тома. Возможные значения — ok , impaired , warning или insufficient-data . Если все проверки пройдены успешно, общее состояние тома — ok . Если проверка завершилась неудачей, общее состояние — impaired . Если состояние — insufficient-data , то проверки могут всё ещё выполняться на вашем томе в данный момент. Рекомендуется повторить запрос. Дополнительную информацию о состоянии тома можно найти в руководстве Amazon EBS User Guide в разделе «Отслеживание состояния ваших томов».

События : отражают причину состояния тома и могут потребовать от вас действий. Например, если ваш том возвращает состояние impaired, то событие тома может быть potential-data-inconsistency. Это означает, что ваш том пострадал от проблемы с базовым узлом, все операции ввода-вывода отключены и данные могут быть несогласованными.

Действия : отражают действия, которые вам может потребоваться предпринять в ответ на событие. Например, если состояние тома — impaired, а событие тома показывает potential-data-inconsistency, то действие показывает enable-volume-io. Это означает, что вы можете включить операции ввода-вывода для тома, вызвав действие EnableVolumeIO, и затем проверить том на согласованность данных.

Состояние тома основано на проверках состояния тома и не отражает состояние тома. Следовательно, состояние тома не указывает на тома в состоянии error (например, когда том не может принимать операции ввода-вывода.)

Примечание

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

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

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

Синтаксис

  describe-volume-status
[--volume-ids <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

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

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

По умолчанию: описывает все ваши тома.

(строка)

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (булево)

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

--filters (список)

Фильтры.

  • action.code — код действия для события (например, enable-volume-io).
  • action.description — описание действия.
  • action.event-id — идентификатор события, связанный с действием.
  • availability-zone — зона доступности экземпляра.
  • event.description — описание события.
  • event.event-id — идентификатор события.
  • event.event-type — тип события (для io-enabled : passed | failed ; для io-performance : io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
  • event.not-after — самое позднее время окончания события.
  • event.not-before — самое раннее время начала события.
  • volume-status.details-name — причина volume-status.status (io-enabled | io-performance).
  • volume-status.details-status — состояние volume-status.details-name (для io-enabled : passed | failed ; для io-performance : normal | degraded | severely-degraded | stalled).
  • volume-status.status — состояние тома (ok | impaired | warning | insufficient-data).

(структура)

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

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

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

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

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

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

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с оператором 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 Command Line Interface User Guide в разделе «Постраничная загрузка».

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

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

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе «Постраничная загрузка».

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

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

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе «Постраничная загрузка».

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

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

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

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

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

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Для описания состояния одного тома

В этом примере команды описывается состояние тома vol-1234567890abcdef0.

Команда:

aws ec2 describe-volume-status --volume-ids vol-1234567890abcdef0

Вывод:

{
    "VolumeStatuses": [
        {
            "VolumeStatus": {
                "Status": "ok",
                "Details": [
                    {
                        "Status": "passed",
                        "Name": "io-enabled"
                    },
                    {
                        "Status": "not-applicable",
                        "Name": "io-performance"
                    }
                ]
            },
            "AvailabilityZone": "us-east-1a",
            "VolumeId": "vol-1234567890abcdef0",
            "Actions": [],
            "Events": []
        }
    ]
}

Для описания состояния поврежденных томов

В этом примере команды описывается состояние всех поврежденных томов. В этом примере вывода нет поврежденных томов.

Команда:

aws ec2 describe-volume-status --filters Name=volume-status.status,Values=impaired

Вывод:

{
    "VolumeStatuses": []
}

Если у вас есть том с проверкой состояния сбоя (состояние — поврежден), см. раздел "Работа с поврежденным томом" в Руководстве пользователя Amazon EC2.

Вывод

NextToken -> (строка)

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

VolumeStatuses -> (список)

Информация о состоянии томов.

(структура)

Описание состояния тома.

Actions -> (список)

Подробности операции.

(структура)

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

Code -> (строка)

Код, идентифицирующий операцию, например, enable-volume-io.

Description -> (строка)

Описание операции.

EventId -> (строка)

Идентификатор события, связанного с этой операцией.

EventType -> (строка)

Тип события, связанного с этой операцией.

AvailabilityZone -> (строка)

Аварийная зона тома.

OutpostArn -> (строка)

Amazon Resource Name (ARN) поста.

Events -> (список)

Список событий, связанных с томом.

(структура)

Описание события состояния тома.

Description -> (строка)

Описание события.

EventId -> (строка)

Идентификатор этого события.

EventType -> (строка)

Тип этого события.

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

Позднейшее время окончания события.

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

Самое раннее время начала события.

InstanceId -> (строка)

Идентификатор экземпляра, связанного с событием.

VolumeId -> (строка)

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

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

Состояние тома.

Details -> (список)

Подробности состояния тома.

(структура)

Описание состояния тома.

Name -> (строка)

Название состояния тома.

Status -> (строка)

Ожидаемое состояние состояния тома.

Status -> (строка)

Состояние тома.

AttachmentStatuses -> (список)

Информация об экземплярах, к которым прикреплен том.

(структура)

Информация об экземплярах, к которым прикреплен том.

IoPerformance -> (строка)

Максимальное значение IOPS, поддерживаемое подключенным экземпляром.

InstanceId -> (строка)

Идентификатор подключенного экземпляра.

AvailabilityZoneId -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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