Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-alias

Описание

Получает свойства псевдонима. Данный операция возвращает все метаданные и настройки псевдонима. Чтобы получить только идентификатор целевого флота псевдонима, используйте ResolveAlias .

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

Связанные действия

Все API по задачам

См. также: AWS API Documentation

Синтаксис

  describe-alias
--alias-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]

Параметры

--alias-id (строка)

Уникальный идентификатор псевдонима флота, который вы хотите получить. Можно использовать либо ID псевдонима, либо значение 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 (строка)

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

  • 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 для вывода.

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

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

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

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

Вывод

Псевдоним -> (структура)

Запрашиваемый ресурс псевдонима.

AliasId -> (строка)

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

Name -> (строка)

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

AliasArn -> (строка)

Amazon Resource Name (ARN) присваиваемый ресурсу Amazon GameLift alias, уникально его идентифицирующий. ARN уникальны во всех регионах. Формат — arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. В ARN псевдонима GameLift идентификатор ресурса соответствует значению ID псевдонима.

Description -> (строка)

Читаемый человеком описание псевдонима.

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

Настройка маршрутизации, включая тип маршрутизации и целевой флот для псевдонима.

Type -> (строка)

Тип стратегии маршрутизации для псевдонима.

Возможные типы маршрутизации включают:

  • SIMPLE - Псевдоним перенаправляется на один конкретный флот. Используйте этот тип при маршрутизации к активным флотам.
  • TERMINAL - Псевдоним не перенаправляется на флот, а вместо этого может быть использован для отображения сообщения пользователю. Терминальный псевдоним выбрасывает исключение TerminalRoutingStrategyException с вложенным сообщением.

FleetId -> (строка)

Уникальный идентификатор флота, к которому указывает псевдоним. Это значение — ID флота, а не ARN флота.

Message -> (строка)

Текст сообщения, используемого со стратегией маршрутизации terminal.

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

Отметка времени, указывающая, когда был создан этот объект данных. Формат — число, выраженное в Unix time в миллисекундах (например, "1469498468.057").

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

Время последнего изменения этого объекта данных. Формат — число, выраженное в Unix time в миллисекундах (например, "1469498468.057").

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

Spec-Zone.ru

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