[ aws . storagegateway ]
describe-stored-iscsi-volumes
Описание
Возвращает описание объёмов шлюза, указанных в запросе. Список объёмов шлюза в запросе должен быть из одного шлюза. В ответе Storage Gateway возвращает информацию об объёмах, отсортированную по ARNs объёмов. Данная операция поддерживается только для типа шлюза хранилища объёмов.
См. также: AWS API Documentation
Синтаксис
describe-stored-iscsi-volumes
--volume-arns <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]
Параметры
--volume-arns (список)
Массив строк, где каждая строка представляет собой Amazon Resource Name (ARN) объёма хранилища. Все указанные объёмы хранилища должны быть с одного шлюза. Используйте ListVolumes для получения ARN объёмов для шлюза.
(строка)
Синтаксис:
"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
- 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.
Вывод
StorediSCSIVolumes -> (список)
Описывает единицу вывода DescribeStorediSCSIVolumes . Возвращаются следующие поля:
-
ChapEnabled: Указывает, включён ли взаимный CHAP для iSCSI-цели. -
LunNumber: Логический номер диска. -
NetworkInterfaceId: Идентификатор сетевого интерфейса объёма хранилища, который инициатор использует для сопоставления объёма хранилища как iSCSI-цели. -
NetworkInterfacePort: Порт, используемый для связи с iSCSI-целями. -
PreservedExistingData: Указывает, когда объём хранилища был создан, при этом данные на базовом локальном диске были сохранены. -
SourceSnapshotId: Если объём хранилища был создан из снимка, это поле содержит идентификатор используемого снимка, например,snap-1122aabb. В противном случае это поле не включено. -
StorediSCSIVolumes: Массив объектов StorediSCSIVolume, где каждый объект содержит метаданные об одном объёме хранилища. -
TargetARN: Amazon Resource Name (ARN) целевого объёма. -
VolumeARN: Amazon Resource Name (ARN) объёма хранилища. -
VolumeDiskId: Идентификатор диска локального диска, указанного в операции CreateStorediSCSIVolume. -
VolumeId: Уникальный идентификатор объёма хранилища, например,vol-1122AABB. -
VolumeiSCSIAttributes: Объект VolumeiSCSIAttributes, представляющий собой набор атрибутов iSCSI для одного объёма хранилища. -
VolumeProgress: Процент выполнения, если объём восстанавливается или выполняется начальная настройка, представляющий собой процент переданных данных. Это поле не отображается в ответе, если объём хранилища не восстанавливается или не выполняется начальная настройка. -
VolumeSizeInBytes: Размер объёма в байтах. -
VolumeStatus: Одно из значенийVolumeStatus, которое указывает состояние объёма. -
VolumeType: Одно из значений перечисления, описывающее тип объёма. В настоящее время поддерживаются только объёмыSTORED.
(структура)
Описывает iSCSI объём хранилища.
VolumeARN -> (строка)
VolumeId -> (строка)
VolumeType -> (строка)
VolumeStatus -> (строка)
VolumeAttachmentStatus -> (строка)
VolumeSizeInBytes -> (длинное целое число)
VolumeProgress -> (вещественное число)
VolumeDiskId -> (строка)
SourceSnapshotId -> (строка)
PreservedExistingData -> (логическое)
Указывает, было ли сохранено содержимое локального диска при создании объёма хранилища.
Допустимые значения: true | false
VolumeiSCSIAttributes -> (структура)
Объект VolumeiSCSIAttributes, представляющий собой набор атрибутов iSCSI для одного объёма хранилища.
TargetARN -> (строка)
NetworkInterfaceId -> (строка)
NetworkInterfacePort -> (целое число)
LunNumber -> (целое число)
ChapEnabled -> (логическое)
CreatedDate -> (временная метка)
VolumeUsedInBytes -> (длинное целое число)
Размер данных, хранящихся в объёме в байтах. Это значение рассчитывается на основе количества затронутых блоков, а не на фактическом количестве записанных данных. Это значение может быть полезным для последовательных записей, но менее точным для случайных записей. VolumeUsedInBytes отличается от сжатого размера объёма, который используется для расчёта платёжных счетов.
Примечание
Это значение недоступно для объёмов, созданных до 13 мая 2015 года, пока вы не сохраните данные в объёме.KMSKey -> (строка)
KMSEncrypted равно true или если EncryptionType равно SseKms или DsseKms.TargetName -> (строка)
Имя iSCSI-цели, используемое инициатором для подключения к объёму и используемое в качестве суффикса для ARN цели. Например, указание TargetName как myvolume приводит к ARN цели arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . Имя цели должно быть уникальным для всех объёмов на одном шлюзе.
Если вы не указываете значение, Storage Gateway использует значение, которое ранее использовалось для этого объёма, в качестве нового имени цели.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|