Spec-Zone.ru › AWS CLI v2

[ aws . autoscaling ]

describe-tags

Описание

Описывает указанные теги.

Вы можете использовать фильтры для ограничения результатов. Например, вы можете запросить теги для определённой группы Auto Scaling. Вы можете указать несколько значений для фильтра. Тег должен соответствовать хотя бы одному из указанных значений, чтобы он был включён в результаты.

Вы также можете указать несколько фильтров. Результат включает информацию о конкретном теге только в том случае, если он соответствует всем фильтрам. Если соответствия нет, никаких специальных сообщений не возвращается.

Дополнительную информацию см. в разделе Тегирование групп и экземпляров Auto Scaling в Руководстве пользователя Amazon EC2 Auto Scaling.

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

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

Синтаксис

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

Один или несколько фильтров для ограничения тегов, которые необходимо вернуть. Максимальное количество фильтров на тип фильтра (например, auto-scaling-group) составляет 1000.

(структура)

Описывает фильтр, используемый для возврата более специфического списка результатов из операции describe.

Если вы укажете несколько фильтров, фильтры автоматически логически объединяются с помощью AND, и запрос возвращает только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе Тегирование групп и экземпляров Auto Scaling в Руководстве пользователя Amazon EC2 Auto Scaling.

Name -> (строка)

Название фильтра.

Допустимые значения для Name зависят от того, какую операцию API вы используете с фильтром (DescribeAutoScalingGroups или DescribeTags).

DescribeAutoScalingGroups

Допустимые значения для Name включают следующее:

  • tag-key - Принимает ключи тегов. Результаты включают только информацию о группах Auto Scaling, связанных с этими ключами тегов.
  • tag-value - Принимает значения тегов. Результаты включают только информацию о группах Auto Scaling, связанных с этими значениями тегов.
  • tag:<key> - Принимает комбинацию ключ/значение тега. Используйте ключ тега в имени фильтра, а значение тега в качестве значения фильтра. Результаты включают только информацию о группах Auto Scaling, связанных с указанной комбинацией ключ/значение.
DescribeTags

Допустимые значения для Name включают следующее:

  • auto-scaling-group - Принимает имена групп Auto Scaling. Результаты включают только информацию о тегах, связанных с этими группами Auto Scaling.
  • key - Принимает ключи тегов. Результаты включают только информацию о тегах, связанных с этими ключами тегов.
  • value - Принимает значения тегов. Результаты включают только информацию о тегах, связанных с этими значениями тегов.
  • propagate-at-launch - Принимает логическое значение, которое указывает, распространяются ли теги на экземпляры при запуске. Результаты включают только информацию о тегах, связанных с указанным логическим значением.

Values -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

Если вы указываете несколько значений для фильтра, значения автоматически логически объединяются с помощью OR, и запрос возвращает все результаты, соответствующие любому из указанных значений. Например, укажите «tag:environment» в качестве имени фильтра и «production,development» в качестве значений фильтра, чтобы найти группы Auto Scaling с тегом «environment=production» или «environment=development».

(строка)

Упрощённый синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["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.

Примеры

Примечание

Для использования следующих примеров, у вас должен быть установлен и настроен AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе «Использование кавычек со строками» в Руководстве пользователя AWS CLI .

Для описания всех тегов

Этот пример описывает все ваши теги.

aws autoscaling describe-tags

Вывод:

{
    "Tags": [
        {
            "ResourceType": "auto-scaling-group",
            "ResourceId": "my-asg",
            "PropagateAtLaunch": true,
            "Value": "Research",
            "Key": "Dept"
        },
        {
            "ResourceType": "auto-scaling-group",
            "ResourceId": "my-asg",
            "PropagateAtLaunch": true,
            "Value": "WebServer",
            "Key": "Role"
        }
    ]
}

Дополнительную информацию см. в разделе «Помечение групп и экземпляров Auto Scaling» в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 2: Для описания тегов для указанной группы

Для описания тегов для определенной группы Auto Scaling используйте параметр --filters.

aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-asg

Дополнительную информацию см. в разделе «Помечение групп и экземпляров Auto Scaling» в Руководстве пользователя Amazon EC2 Auto Scaling.

Пример 3: Для описания заданного количества тегов

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

aws autoscaling describe-tags \
    --max-items 1

Если в выводе присутствует поле NextToken, это означает, что есть дополнительные теги. Чтобы получить дополнительные теги, используйте значение этого поля с параметром --starting-token в последующем вызове следующим образом.

aws autoscaling describe-tags \
    --filters Name=auto-scaling-group,Values=my-asg \
    --starting-token Z3M3LMPEXAMPLE

Дополнительную информацию см. в разделе «Помечение групп и экземпляров Auto Scaling» в Руководстве пользователя Amazon EC2 Auto Scaling.

Вывод

Теги -> (список)

Один или несколько тегов.

(структура)

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

ResourceId -> (строка)

Имя группы.

ResourceType -> (строка)

Тип ресурса. Единственное поддерживаемое значение — auto-scaling-group.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

PropagateAtLaunch -> (булево)

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

NextToken -> (строка)

Строка, указывающая, что ответ содержит больше элементов, чем может быть возвращено в одном ответе. Для получения дополнительных элементов укажите эту строку для значения NextToken при запросе следующего набора элементов. Это значение равно null, когда больше элементов возвращать не нужно.

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

Spec-Zone.ru

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