Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-disks

Описание

Возвращает информацию обо всех дисках блочного хранилища в вашей учётной записи AWS и регионе.

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

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

Синтаксис

  get-disks
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

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

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

Примеры использования см. в разделе Постраничность в руководстве пользователя 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 (логическое значение)

Включает отладовую запись в журнал.

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

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

Выражение JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

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

--no-sign-request (логическое значение)

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

--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 (логическое значение)

Отключение постраничной обработки cli для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для получения информации обо всех дисках блочного хранилища

Следующий get-disks пример отображает подробности обо всех дисках в настроенном регионе AWS.

aws lightsail get-disks

Вывод:

{
    "disks": [
        {
            "name": "Disk-2",
            "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/6a343ff8-6341-422d-86e2-bEXAMPLE16c2",
            "supportCode": "6EXAMPLE3362/vol-0EXAMPLE929602087",
            "createdAt": 1571090461.634,
            "location": {
                "availabilityZone": "us-west-2a",
                "regionName": "us-west-2"
            },
            "resourceType": "Disk",
            "tags": [],
            "sizeInGb": 8,
            "isSystemDisk": false,
            "iops": 100,
            "state": "available",
            "isAttached": false,
            "attachmentState": "detached"
        },
        {
            "name": "Disk-1",
            "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096",
            "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f",
            "createdAt": 1566585439.587,
            "location": {
                "availabilityZone": "us-west-2a",
                "regionName": "us-west-2"
            },
            "resourceType": "Disk",
            "tags": [],
            "sizeInGb": 8,
            "isSystemDisk": false,
            "iops": 100,
            "path": "/dev/xvdf",
            "state": "in-use",
            "attachedTo": "WordPress_Multisite-1",
            "isAttached": true,
            "attachmentState": "attached"
        }
    ]
}

Вывод

disks -> (список)

Массив объектов, содержащих информацию обо всех дисках блочного хранилища.

(структура)

Описание диска блочного хранилища.

name -> (строка)

Уникальное имя диска.

arn -> (строка)

Amazon Resource Name (ARN) диска.

supportCode -> (строка)

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

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

Дата создания диска.

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

AWS регион и зона доступности, где расположен диск.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail (Disk).

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Более подробную информацию о тегах в Lightsail можно найти в руководстве разработчика Amazon Lightsail.

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Более подробную информацию о тегах в Lightsail можно найти в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

addOns -> (список)

Массив объектов, представляющих дополнения, включенные в диск.

(структура)

Описание дополнения, включенного для ресурса Amazon Lightsail.

name -> (строка)

Имя дополнения.

status -> (строка)

Статус дополнения.

snapshotTimeOfDay -> (строка)

Ежедневное время создания автоматической копии.

Время отображается в формате HH:00 и в формате Coordinated Universal Time (UTC).

Копия автоматически создается между указанным временем и через 45 минут после него.

nextSnapshotTimeOfDay -> (строка)

Следующее ежедневное время создания автоматической копии.

Время отображается в формате HH:00 и в формате Coordinated Universal Time (UTC).

Копия автоматически создается между указанным временем и через 45 минут после него.

threshold -> (строка)

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

Предупреждение

Это дополнение применяется только к ресурсам Lightsail for Research.

duration -> (строка)

Количество времени простоя в минутах, после которого виртуальная машина автоматически остановится.

Предупреждение

Это дополнение применяется только к ресурсам Lightsail for Research.

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

Размер диска в ГБ.

isSystemDisk -> (булево)

Логическое значение, указывающее, является ли этот диск системным диском (на котором загружена операционная система).

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

Ввод/вывод операций в секунду (IOPS) диска.

path -> (строка)

Путь к диску.

state -> (строка)

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

attachedTo -> (строка)

Ресурсы, к которым прикреплен диск.

isAttached -> (булево)

Логическое значение, указывающее, прикреплен ли диск.

attachmentState -> (строка)

(Устаревшее) Состояние прикрепления диска.

Примечание

В версиях до 14 ноября 2017 года этот параметр возвращал attached для системных дисков в ответе API. Он теперь устарел, но по-прежнему включен в ответ. Используйте isAttached вместо него.

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

(Устаревшее) Количество использованных ГБ диском.

Примечание

В версиях до 14 ноября 2017 года этот параметр не включался в ответ API. Он теперь устарел.

autoMountStatus -> (строка)

Статус автоматического подключения диска хранилища к виртуальной машине.

Предупреждение

Этот параметр применим только к ресурсам Lightsail for Research.

nextPageToken -> (строка)

Токен для перехода к следующей странице результатов вашего запроса.

Токен следующей страницы не возвращается, если больше результатов отображать не нужно.

Чтобы получить следующую страницу результатов, выполните еще один запрос GetDisks и укажите токен следующей страницы с помощью параметра pageToken.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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