describe-tags
Описание
Описывает указанные теги для ваших ресурсов EC2.
Дополнительную информацию о тегах см. в разделе Назначение тегов ресурсам Amazon EC2 в руководстве пользователя Amazon Elastic Compute Cloud.
Предупреждение
Сильно рекомендуем использовать только запросы с постраничной навигацией. Запросы без постраничной навигации подвержены ограничениям по частоте запросов и таймаутам.Примечание
Порядок элементов в ответе, включая элементы вложенных структур, может отличаться. Приложения не должны предполагать какой-либо определённый порядок элементов.См. также: Документацию API AWS
describe-tags является операцией с постраничной навигацией. Для получения всего набора результатов могут быть выпущены несколько API-запросов. Вы можете отключить постраничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией аргумент --query должен извлекать данные из результатов следующих выражений запроса: Tags
Синтаксис
describe-tags
[--dry-run | --no-dry-run]
[--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]
Параметры
--dry-run | --no-dry-run (логическое значение)
DryRunOperation. В противном случае — UnauthorizedOperation.--filters (список)
Фильтры.
-
key— ключ тега. -
resource-id— идентификатор ресурса. -
resource-type— тип ресурса. Список возможных значений см. в TagSpecification. -
tag:<key> — комбинация ключ/значение тега. Например, укажите «tag:Owner» для имени фильтра и «TeamA» для значения фильтра, чтобы найти ресурсы с тегом «Owner=TeamA». -
value— значение тега.
(структура)
Пара имя-значение фильтра, которая используется для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы укажете несколько фильтров, фильтры будут объединены с помощью AND, и запрос вернёт только результаты, соответствующие всем указанным фильтрам.
Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в руководстве пользователя Amazon EC2.
Name -> (строка)
Values -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения будут объединены с помощью OR, и запрос вернёт все результаты, соответствующие любому из указанных значений.
(строка)
Сокращенный синтаксис:
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
- текст
- таблица
- yaml
- yaml-поток
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробнее см. в руководстве пользователя AWS CLI в разделе "Начало работы".
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. Дополнительные сведения см. в руководстве пользователя AWS CLI в разделе "Использование кавычек со строками".
Пример 1: Описание всех тегов для одного ресурса
Следующий пример описывает теги для указанного экземпляра.
aws ec2 describe-tags \
--filters "Name=resource-id,Values=i-1234567890abcdef8"
Вывод:
{
"Tags": [
{
"ResourceType": "instance",
"ResourceId": "i-1234567890abcdef8",
"Value": "Test",
"Key": "Stack"
},
{
"ResourceType": "instance",
"ResourceId": "i-1234567890abcdef8",
"Value": "Beta Server",
"Key": "Name"
}
]
}
Пример 2: Описание всех тегов для типа ресурса
Следующий пример описывает теги для ваших томов.
aws ec2 describe-tags \
--filters "Name=resource-type,Values=volume"
Вывод:
{
"Tags": [
{
"ResourceType": "volume",
"ResourceId": "vol-1234567890abcdef0",
"Value": "Project1",
"Key": "Purpose"
},
{
"ResourceType": "volume",
"ResourceId": "vol-049df61146c4d7901",
"Value": "Logs",
"Key": "Purpose"
}
]
}
Пример 3: Описание всех ваших тегов
Следующий пример описывает теги для всех ваших ресурсов.
aws ec2 describe-tags
Пример 4: Описание тегов для ваших ресурсов на основе ключа тега
Следующий пример описывает теги для ваших ресурсов, которые имеют тег с ключом Stack.
aws ec2 describe-tags \
--filters Name=key,Values=Stack
Вывод:
{
"Tags": [
{
"ResourceType": "volume",
"ResourceId": "vol-027552a73f021f3b",
"Value": "Production",
"Key": "Stack"
},
{
"ResourceType": "instance",
"ResourceId": "i-1234567890abcdef8",
"Value": "Test",
"Key": "Stack"
}
]
}
Пример 5: Описание тегов для ваших ресурсов на основе ключа тега и значения тега
Следующий пример описывает теги для ваших ресурсов, которые имеют тег Stack=Test.
aws ec2 describe-tags \
--filters Name=key,Values=Stack Name=value,Values=Test
Вывод:
{
"Tags": [
{
"ResourceType": "image",
"ResourceId": "ami-3ac336533f021f3bd",
"Value": "Test",
"Key": "Stack"
},
{
"ResourceType": "instance",
"ResourceId": "i-1234567890abcdef8",
"Value": "Test",
"Key": "Stack"
}
]
}
Следующий пример использует альтернативный синтаксис для описания ресурсов с тегом Stack=Test.
aws ec2 describe-tags \
--filters "Name=tag:Stack,Values=Test"
Следующий пример описывает теги для всех ваших экземпляров, которые имеют тег с ключом Purpose и без значения.
aws ec2 describe-tags \
--filters "Name=resource-type,Values=instance" "Name=key,Values=Purpose" "Name=value,Values="
Вывод:
{
"Tags": [
{
"ResourceType": "instance",
"ResourceId": "i-1234567890abcdef5",
"Value": null,
"Key": "Purpose"
}
]
}
Вывод
NextToken -> (строка)
null, когда больше элементов возвращать не нужно.Теги -> (список)
Теги.
(структура)
Описание тега.
Ключ -> (строка)
ResourceId -> (строка)
ResourceType -> (строка)
Значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.