list-managed-resources

Описание

Выводит список всех ресурсов в вашей учетной записи Amazon Web Services в этой области Amazon Web Services, управляемых для зональных сдвигов в Amazon Route 53 Application Recovery Controller, и информацию о них. Информация включает статус зонального автосдвига для ресурса, а также Amazon Resource Name (ARN), зоны доступности, в которых развернут каждый ресурс, и имя ресурса.

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

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

Синтаксис

  list-managed-resources
[--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]

Параметры

--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 -> (список)

Элементы в списке ответа.

(структура)

Сложная структура управляемого ресурса в учетной записи Amazon Web Services с информацией о зональных смещениях и автоматическом смещении.

Управляемый ресурс — это балансировщик нагрузки, зарегистрированный в ARC с помощью Elastic Load Balancing. Вы можете начать зональное смещение в ARC для управляемого ресурса, чтобы временно перенаправить трафик ресурса из зоны доступности в регионе Amazon Web Services. Вы также можете настроить автоматическое зональное смещение для управляемого ресурса.

Примечание

На данный момент управляемые ресурсы — это балансировщики сети и балансировщики приложений с отключенным межзонным балансированием.

appliedWeights -> (карта)

Коллекция пар ключ-значение, указывающая, активны ли ресурсы в зонах доступности. Имя ключа — зона доступности, где развернут ресурс. Значение — 1 или 0.

ключ -> (строка)

значение -> (число с плавающей точкой)

arn -> (строка)

Идентификатор Amazon Resource Name (ARN) управляемого ресурса.

autoshifts -> (список)

Массив завершенных автоматических смещений для ресурса.

(структура)

Сложная структура, которая перечисляет активное автоматическое смещение для управляемого ресурса и информацию об этом смещении.

Дополнительную информацию см. в разделе Как работают автоматическое зональное смещение и тестовые запуски в руководстве разработчика Amazon Route 53 Application Recovery Controller.

appliedStatus -> (строка)

Поле appliedStatus указывает, какое смещение трафика приложения активно для ресурса, когда активных смещений трафика несколько. Одновременно может быть несколько активных смещений трафика приложения: тестовые запуски зональных смещений, инициированные пользователем зональные смещения или автоматическое смещение. Поле appliedStatus для смещения, активного для ресурса, может иметь одно из двух значений: APPLIED или NOT_APPLIED. Зональное смещение или автоматическое смещение, которые в данный момент активны для ресурса, имеют appliedStatus значение APPLIED.

Основной принцип приоритетов заключается в том, что зональные смещения, инициированные пользователем, имеют приоритет перед автоматическим смещением, которое имеет приоритет перед тестовыми запусками. То есть, зональные смещения, инициированные пользователем > автоматические смещения > тестовые запуски зональных смещений.

awayFrom -> (строка)

Зона доступности (например, use1-az1), трафик которой смещается для ресурса при запуске автоматического смещения Amazon Web Services. До завершения автоматического смещения трафик ресурса вместо этого направляется в другие зоны доступности в регионе Amazon Web Services. Автоматическое смещение может закончиться для ресурса, например, когда Amazon Web Services завершает автоматическое смещение для зоны доступности или когда вы отключаете автоматическое зональное смещение для ресурса.

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

Время (UTC), когда началось автоматическое смещение.

availabilityZones -> (список)

Зоны доступности, в которых развернут ресурс.

(строка)

name -> (строка)

Имя управляемого ресурса.

practiceRunStatus -> (строка)

Этот статус отслеживает, существует ли конфигурация тестового запуска для ресурса. При конфигурировании тестового запуска для ресурса, таким образом, что существует конфигурация тестового запуска, ARC устанавливает это значение в ENABLED. Если вы не настроили тестовый запуск для ресурса или удалили конфигурацию тестового запуска, ARC устанавливает значение в DISABLED.

ARC обновляет этот статус; вы не можете установить статус тестового запуска в ENABLED или DISABLED.

zonalAutoshiftStatus -> (строка)

Статус автоматического смещения для ресурса. При настройке автоматического зонального смещения для ресурса вы можете установить значение статуса в ENABLED или DISABLED.

zonalShifts -> (список)

Массив зональных смещений для ресурса.

(структура)

Сложная структура, которая перечисляет зональные смещения для управляемого ресурса и их статусы для ресурса.

appliedStatus -> (строка)

awayFrom -> (строка)

Зона доступности (например, use1-az1), трафик которой перенаправляется для ресурса при запуске зонального смещения. До истечения срока действия зонального смещения или его отмены трафик ресурса перенаправляется в другие зоны доступности в регионе Amazon Web Services.

comment -> (строка)

Комментарий, который вы вводите для зонального смещения, инициированного пользователем. Сохраняется только последний комментарий; история комментариев не сохраняется. То есть, новый комментарий перезаписывает любую существующую строку комментария.

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

Время истечения срока действия (время истечения срока действия) для зонального смещения, инициированного пользователем. Зональное смещение временное и должно истекать при запуске зонального смещения. Изначально зональное смещение может истечь в течение максимум трех дней (72 часов). Однако вы можете обновить зональное смещение, чтобы установить новое время истечения в любое время.

При запуске зонального смещения вы указываете, как долго вы хотите его сохранить, что ARC преобразует во время истечения (время истечения). Вы можете отменить зональное смещение, когда готовы восстановить трафик в зону доступности, или просто подождать его истечения. Или вы можете обновить зональное смещение, чтобы указать другой срок истечения.

practiceRunOutcome -> (строка)

Результат или конечное состояние, возвращенное для тестового запуска. Возможные значения:

ОЖИДАЕТСЯ: Значение результата, когда тестовый запуск находится в процессе.
УСПЕШНО: Значение результата, когда сигнал тревоги результата, указанный для конфигурации тестового запуска, не переходит в состояние ALARM во время тестового запуска, и тестовый запуск не был прерван до завершения ожидаемого 30-минутного зонального смещения.
ПРЕРВАН: Значение результата, когда тестовый запуск был остановлен до ожидаемой продолжительности 30-минутного зонального смещения или возникла другая проблема с тестовым запуском, которая привела к неопределенному результату.
НЕУДАЛОСЬ: Значение результата, когда сигнал тревоги результата, указанный для конфигурации тестового запуска, переходит в состояние ALARM во время тестового запуска, и тестовый запуск не был прерван до завершения.

Дополнительную информацию о результатах тестового запуска см. в разделе Учетные моменты при настройке автоматического зонального смещения в руководстве разработчика Amazon Route 53 Application Recovery Controller.

resourceIdentifier -> (строка)

Идентификатор ресурса, который нужно включить в зональное смещение. Идентификатор — это Amazon Resource Name (ARN) ресурса.

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

shiftType -> (строка)

Определяет тип зонального смещения.

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

Время (UTC), когда начинается зональное смещение.

zonalShiftId -> (строка)

Идентификатор зонального смещения.

nextToken -> (строка)

Указывает, что вы хотите получить следующую страницу результатов. Действительно только если вы получили ответ nextToken в предыдущем запросе. Если да, это указывает на то, что доступно больше вывода. Установите этот параметр в значение, предоставленное ответом nextToken предыдущего вызова, чтобы запросить следующую страницу результатов.

END_OF_DOCUMENT_MARKER