Spec-Zone.ru › AWS CLI v2

[ aws . opsworks ]

describe-volumes

Описание

Описывает тома Amazon EBS экземпляра.

Примечание

Этот вызов принимает только один параметр идентификации ресурса.

Требуемые разрешения : для использования этого действия пользователь IAM должен иметь уровень разрешений «Показать», «Развернуть» или «Управлять» для стека или прикреплённую политику, которая явно предоставляет разрешения. Дополнительную информацию о разрешениях пользователей см. в разделе Управление разрешениями пользователей .

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

Синтаксис

  describe-volumes
[--instance-id <value>]
[--stack-id <value>]
[--raid-array-id <value>]
[--volume-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--instance-id (строка)

Идентификатор экземпляра. Если вы используете этот параметр, DescribeVolumes возвращает описания томов, связанных с указанным экземпляром.

--stack-id (строка)

Идентификатор стека. Действие описывает зарегистрированные Amazon EBS тома стека.

--raid-array-id (строка)

Идентификатор массива RAID. Если вы используете этот параметр, DescribeVolumes возвращает описания томов, связанных с указанным массивом RAID.

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

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

(строка)

Синтаксис:

"string" "string" ...

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

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включить
  • выключить
  • автоматически

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

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

Следующий пример описывает тома EBS стека.

aws opsworks --region us-east-1 describe-volumes --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8

Вывод:

{
  "Volumes": [
    {
      "Status": "in-use",
      "AvailabilityZone": "us-west-2a",
      "Name": "CLITest",
      "InstanceId": "dfe18b02-5327-493d-91a4-c5c0c448927f",
      "VolumeType": "standard",
      "VolumeId": "56b66fbd-e1a1-4aff-9227-70f77118d4c5",
      "Device": "/dev/sdi",
      "Ec2VolumeId": "vol-295c1638",
      "MountPoint": "/mnt/myvolume",
      "Size": 1
    }
  ]
}

Дополнительная информация

Дополнительную информацию см. в разделе Управление ресурсами в Руководстве пользователя AWS OpsWorks.

Вывод

Тома -> (список)

Массив идентификаторов томов.

(структура)

Описывает том Amazon EBS экземпляра.

VolumeId -> (строка)

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

Ec2VolumeId -> (строка)

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

Name -> (строка)

Имя тома. Имена томов не превышают 128 символов.

RaidArrayId -> (строка)

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

InstanceId -> (строка)

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

Status -> (строка)

Значение, возвращаемое DescribeVolumes .

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

Размер тома.

Device -> (строка)

Имя устройства.

MountPoint -> (строка)

Точка монтирования тома. Например, “/mnt/disk1”.

Region -> (строка)

Регион Amazon Web Services. Дополнительную информацию о регионах Amazon Web Services см. в разделе Регионы и конечные точки .

AvailabilityZone -> (строка)

Зона доступности тома. Дополнительную информацию см. в разделе Регионы и конечные точки .

VolumeType -> (строка)

Тип тома. Дополнительную информацию см. в разделе Типы томов Amazon EBS .

  • standard - Магнитный. Магнитные тома должны иметь минимальный размер 1 ГБ и максимальный размер 1024 ГБ.
  • io1 - Provisioned IOPS (SSD). Тома PIOPS должны иметь минимальный размер 4 ГБ и максимальный размер 16384 ГБ.
  • gp2 - Общего назначения (SSD). Тома общего назначения должны иметь минимальный размер 1 ГБ и максимальный размер 16384 ГБ.
  • st1 - HDD с оптимизированной пропускной способностью. Тома HDD с оптимизированной пропускной способностью должны иметь минимальный размер 125 ГБ и максимальный размер 16384 ГБ.
  • sc1 - Cold HDD. Тома Cold HDD должны иметь минимальный размер 125 ГБ и максимальный размер 16384 ГБ.

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

Для томов PIOPS - IOPS на диск.

Encrypted -> (булево)

Указывает, зашифрован ли том Amazon EBS. Дополнительную информацию см. в разделе Шифрование Amazon EBS .

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

Spec-Zone.ru

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