Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-instance-properties

Описание

Операция API, используемая консолью Systems Manager для отображения информации о управляемых узлах Systems Manager.

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

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

Синтаксис

  describe-instance-properties
[--instance-property-filter-list <value>]
[--filters-with-operator <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]

Параметры

--instance-property-filter-list (список)

Массив фильтров свойств экземпляра.

(структура)

Описывает фильтр для определённого списка управляемых узлов. Вы можете фильтровать информацию о узлах с помощью тегов. Теги задаются с помощью сопоставления ключ-значение.

key -> (строка)

Имя фильтра.

valueSet -> (список)

Значения фильтра.

(строка)

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

key=string,valueSet=string,string ...

Синтаксис JSON:

[
  {
    "key": "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"DocumentName"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus",
    "valueSet": ["string", ...]
  }
  ...
]

--filters-with-operator (список)

Фильтры запроса для использования с оператором.

(структура)

Фильтры для описания или получения информации о управляемых узлах.

Key -> (строка)

Имя ключа фильтра для описания управляемых узлов.

Values -> (список)

Имя ключа фильтра для описания управляемых узлов.

(строка)

Operator -> (строка)

Оператор, используемый в фильтре.

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

Key=string,Values=string,string,Operator=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Operator": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
  }
  ...
]

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

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

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

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

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

Вывод

InstanceProperties -> (список)

Свойства управляемых экземпляров.

(структура)

Объект, содержащий различные свойства управляемого узла.

Name -> (строка)

Значение тега EC2 Name, связанного с узлом. Если тег Name не применён к узлу, это значение пустое.

InstanceId -> (строка)

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

InstanceType -> (строка)

Тип экземпляра управляемого узла. Например, t3.large.

InstanceRole -> (строка)

Профиль экземпляра, присоединённый к узлу. Если к узлу не присоединён профиль экземпляра, это значение пустое.

KeyName -> (строка)

Имя пары ключей, связанной с узлом. Если к узлу не прикреплена пара ключей, это значение пустое.

InstanceState -> (строка)

Текущее состояние узла.

Architecture -> (строка)

Архитектура ЦП узла. Например, x86_64.

IPAddress -> (строка)

Присвоенный узлу общедоступный IPv4-адрес. Если узлу не присвоен общедоступный IPv4-адрес, это значение пустое.

LaunchTime -> (временная метка)

Временная метка запуска узла.

PingStatus -> (строка)

Статус подключения SSM Agent на управляемом узле.

LastPingDateTime -> (временная метка)

Дата и время, когда SSM Agent в последний раз отправил сигнал ping службам Systems Manager.

AgentVersion -> (строка)

Версия SSM Agent, работающая на вашем управляемом узле.

PlatformType -> (строка)

Тип платформы операционной системы управляемого узла. Например, Windows Server или Amazon Linux 2.

PlatformName -> (строка)

Имя операционной системы, работающей на вашем управляемом узле.

PlatformVersion -> (строка)

Версия платформы ОС, работающей на вашем управляемом узле.

ActivationId -> (строка)

Идентификатор активации, созданный Systems Manager при регистрации сервера или виртуальной машины (VM).

IamRole -> (строка)

IAM-роль, используемая при гибридной активации для регистрации узла в Systems Manager.

RegistrationDate -> (временная метка)

Дата регистрации узла в Systems Manager.

ResourceType -> (строка)

Тип управляемого узла.

ComputerName -> (строка)

Полное имя хоста управляемого узла.

AssociationStatus -> (строка)

Статус применения ассоциации State Manager к управляемому узлу.

LastAssociationExecutionDate -> (временная метка)

Дата последнего запуска ассоциации.

LastSuccessfulAssociationExecutionDate -> (временная метка)

Последняя дата успешного запуска ассоциации.

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

Сведения о статусе агрегированных ассоциаций.

DetailedStatus -> (строка)

Подробные сведения о статусе агрегированных ассоциаций.

InstanceAssociationStatusAggregatedCount -> (массив)

Количество ассоциаций для управляемых узлов.

key -> (строка)

value -> (целое число)

SourceId -> (строка)

Идентификатор источника ресурса.

SourceType -> (строка)

Тип ресурса источника.

NextToken -> (строка)

Токен для следующего набора возвращаемых свойств. Используйте этот токен для получения следующего набора результатов.

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

Spec-Zone.ru

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