Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

получить-диск

Описание

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

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

Синтаксис

  get-disk
--disk-name <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]

Параметры

--disk-name (строка)

Имя диска (my-disk).

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

Чтобы получить информацию о диске блочного хранилища

Следующий get-disk пример отображает подробности о диске Disk-1.

aws lightsail get-disk \
    --disk-name Disk-1

Вывод:

{
    "disk": {
        "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"
    }
}

Для получения дополнительной информации см. заголовок в руководстве.

Вывод

диск -> (структура)

Объект, содержащий информацию о диске.

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

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

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.

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

Spec-Zone.ru

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