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 -> (строка)
Name, связанного с узлом. Если тег Name не применён к узлу, это значение пустое.InstanceId -> (строка)
InstanceType -> (строка)
InstanceRole -> (строка)
KeyName -> (строка)
InstanceState -> (строка)
Architecture -> (строка)
x86_64.IPAddress -> (строка)
LaunchTime -> (временная метка)
PingStatus -> (строка)
LastPingDateTime -> (временная метка)
AgentVersion -> (строка)
PlatformType -> (строка)
PlatformName -> (строка)
PlatformVersion -> (строка)
ActivationId -> (строка)
IamRole -> (строка)
RegistrationDate -> (временная метка)
ResourceType -> (строка)
ComputerName -> (строка)
AssociationStatus -> (строка)
LastAssociationExecutionDate -> (временная метка)
LastSuccessfulAssociationExecutionDate -> (временная метка)
AssociationOverview -> (структура)
Сведения о статусе агрегированных ассоциаций.
DetailedStatus -> (строка)
InstanceAssociationStatusAggregatedCount -> (массив)
Количество ассоциаций для управляемых узлов.
key -> (строка)
value -> (целое число)
SourceId -> (строка)
SourceType -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|