Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

describe-traffic-distribution-group

Описание

Получает подробную информацию и статус группы распределения трафика.

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

Синтаксис

  describe-traffic-distribution-group
--traffic-distribution-group-id <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]

Параметры

--traffic-distribution-group-id (строка)

Идентификатор группы распределения трафика. Это может быть идентификатор или ARN, если API вызывается в регионе, где была создана группа распределения трафика. ARN должен быть предоставлен, если вызов происходит из реплицированного региона.

--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 (строка)

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

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

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

Вывод

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

Информация о группе распределения трафика.

Id -> (строка)

Идентификатор группы распределения трафика. Это может быть идентификатор или ARN, если API вызывается в регионе, где была создана группа распределения трафика. ARN должен быть предоставлен, если вызов происходит из реплицированного региона.

Arn -> (строка)

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

Name -> (строка)

Название группы распределения трафика.

Description -> (строка)

Описание группы распределения трафика.

InstanceArn -> (строка)

Amazon Resource Name (ARN).

Status -> (строка)

Статус группы распределения трафика.

  • CREATION_IN_PROGRESS означает, что предыдущая операция CreateTrafficDistributionGroup все еще выполняется и не завершена.
  • ACTIVE означает, что предыдущая операция CreateTrafficDistributionGroup выполнена успешно.
  • CREATION_FAILED указывает, что предыдущая операция CreateTrafficDistributionGroup завершилась неудачно.
  • PENDING_DELETION означает, что предыдущая операция DeleteTrafficDistributionGroup все еще выполняется и не завершена.
  • DELETION_FAILED означает, что предыдущая операция DeleteTrafficDistributionGroup завершилась неудачно.
  • UPDATE_IN_PROGRESS означает, что предыдущая операция UpdateTrafficDistribution все еще выполняется и не завершена.

Tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

key -> (строка)

value -> (строка)

IsDefault -> (логическое значение)

Указывает, является ли эта группа распределения трафика группой по умолчанию, созданной во время репликации экземпляра. Группу распределения трафика по умолчанию нельзя удалить с помощью API DeleteTrafficDistributionGroup. Группа распределения трафика по умолчанию удаляется в ходе процесса удаления реплики.

Примечание

Распределение SignInConfig доступно только для группы распределения трафика по умолчанию TrafficDistributionGroup (см. параметр IsDefault в типе данных TrafficDistributionGroup). Если вы вызываете UpdateTrafficDistribution с измененным SignInConfig и нестандартной группой распределения трафика TrafficDistributionGroup, возвращается InvalidRequestException.

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

Spec-Zone.ru

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