Spec-Zone.ru › AWS CLI v2

[ aws . drs ]

describe-recovery-instances

Описание

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

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

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

Синтаксис

  describe-recovery-instances
[--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]

Параметры

--filters (структура)

Набор фильтров для возврата экземпляров восстановления.

recoveryInstanceIDs -> (список)

Массив идентификаторов экземпляров восстановления, которые должны быть возвращены. Пустой массив означает все экземпляры восстановления.

(строка)

sourceServerIDs -> (список)

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

(строка)

Сокращенный синтаксис:

recoveryInstanceIDs=string,string,sourceServerIDs=string,string

Синтаксис JSON:

{
  "recoveryInstanceIDs": ["string", ...],
  "sourceServerIDs": ["string", ...]
}

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

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

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

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

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

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

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

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

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

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

Вывод

items -> (список)

Массив экземпляров восстановления.

(структура)

Экземпляр восстановления — это реплика сервера источника, работающего на EC2.

agentVersion -> (строка)

Версия агента DRS, установленного на экземпляре восстановления

arn -> (строка)

ARN экземпляра восстановления.

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

Данные о репликации данных экземпляра восстановления.

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

Информация о репликации данных

error -> (строка)

Ошибка репликации данных.

rawError -> (строка)

Ошибка репликации данных.

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

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

startDateTime -> (строка)

Дата и время текущей попытки инициировать репликацию данных.

steps -> (список)

Шаги текущей попытки инициировать репликацию данных.

(структура)

Шаг инициирования репликации данных.

name -> (строка)

Название шага.

status -> (строка)

Статус шага.

dataReplicationState -> (строка)

Состояние репликации данных.

etaDateTime -> (строка)

Приблизительное время завершения репликации данных.

lagDuration -> (строка)

Продолжительность отставания при репликации данных.

replicatedDisks -> (список)

Диски, которые должны быть реплицированы.

(структура)

Диск, который должен быть реплицирован.

backloggedStorageBytes -> (длинное целое)

Размер очереди репликации в байтах.

deviceName -> (строка)

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

replicatedStorageBytes -> (длинное целое)

Объем данных, реплицированных до сих пор, в байтах.

rescannedStorageBytes -> (длинное целое)

Объем данных, которые необходимо пересканировать, в байтах.

totalStorageBytes -> (длинное целое)

Общий объем данных, подлежащих репликации, в байтах.

stagingAvailabilityZone -> (строка)

Зона доступности AWS, в которую данные реплицируются.

stagingOutpostArn -> (строка)

ARN подсистемы Staging Outpost

ec2InstanceID -> (строка)

ID экземпляра EC2 экземпляра восстановления.

ec2InstanceState -> (строка)

Состояние экземпляра EC2 для данного экземпляра восстановления.

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

Объект, представляющий информацию о восстановлении экземпляра восстановления.

agentLastSeenByServiceDateTime -> (строка)

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

elapsedReplicationDuration -> (строка)

Время, в течение которого экземпляр восстановления выполнял репликацию.

failbackClientID -> (строка)

ID клиента восстановления, с которым связан этот экземпляр восстановления.

failbackClientLastSeenByServiceDateTime -> (строка)

Дата и время, когда клиент восстановления был последний раз обнаружен сервисом.

failbackInitiationTime -> (строка)

Дата и время начала инициирования восстановления.

failbackJobID -> (строка)

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

failbackLaunchType -> (строка)

Тип запуска (Восстановление/Упражнение) последнего запуска для репликации восстановления этого экземпляра восстановления.

failbackToOriginalServer -> (булево)

Выполняется ли возврат к исходному серверу для данного экземпляра восстановления.

firstByteDateTime -> (строка)

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

state -> (строка)

Состояние процесса восстановления, в котором находится данный экземпляр восстановления.

isDrill -> (булево)

Создан ли этот экземпляр восстановления для упражнения или для реального события восстановления.

jobID -> (строка)

ID задачи, которая создала экземпляр восстановления.

originAvailabilityZone -> (строка)

Зона доступности AWS, связанная с экземпляром восстановления.

originEnvironment -> (строка)

Среда (локальная/AWS) экземпляра, из которого исходит экземпляр восстановления.

pointInTimeSnapshotDateTime -> (строка)

Дата и время моментального снимка точки времени (PIT), из которого был запущен этот экземпляр восстановления.

recoveryInstanceID -> (строка)

ID экземпляра восстановления.

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

Свойства компьютера экземпляра восстановления.

cpus -> (список)

Массив процессоров.

(структура)

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

cores -> (длинное целое)

Количество ядер процессора.

modelName -> (строка)

Модель процессора.

disks -> (список)

Массив дисков.

(структура)

Объект, представляющий устройство хранения данных на экземпляре восстановления.

bytes -> (длинное целое)

Объем памяти на диске в байтах.

ebsVolumeID -> (строка)

ID тома EBS этого диска.

internalDeviceName -> (строка)

Внутреннее имя устройства этого диска. Это имя, видимое на самом компьютере, а не из консоли EC2.

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

Подсказки, используемые для уникальной идентификации компьютера.

awsInstanceID -> (строка)

Подсказка для идентификации ID экземпляра AWS.

fqdn -> (строка)

Подсказка для идентификации полного доменного имени.

hostname -> (строка)

Подсказка для идентификации имени хоста.

vmWareUuid -> (строка)

Подсказка для идентификации пути виртуальной машины vCenter.

lastUpdatedDateTime -> (строка)

Дата и время последнего обновления свойств экземпляра восстановления.

networkInterfaces -> (список)

Массив сетевых интерфейсов.

(структура)

Сетевой интерфейс.

ips -> (список)

IP-адреса сетевого интерфейса.

(строка)

isPrimary -> (булево)

Является ли это первичным сетевым интерфейсом.

macAddress -> (строка)

MAC-адрес сетевого интерфейса.

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

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

fullString -> (строка)

Полное имя операционной системы.

ramBytes -> (длинное целое)

Объем оперативной памяти в байтах.

sourceOutpostArn -> (строка)

ARN исходной подсистемы Outpost

sourceServerID -> (строка)

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

tags -> (карта)

Массив тегов, связанных с экземпляром восстановления.

key -> (строка)

value -> (строка)

nextToken -> (строка)

Токен следующего экземпляра восстановления для извлечения.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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