[ aws . devops-guru ]
describe-resource-collection-health
Описание
Возвращает количество открытых проактивных инсайтов, открытых реактивных инсайтов и среднее время восстановления (MTTR) для всех закрытых инсайтов в коллекциях ресурсов в вашей учетной записи. Вы указываете тип коллекции ресурсов Amazon Web Services. Два поддерживаемых типа коллекций ресурсов Amazon Web Services — это стеки Amazon Web Services CloudFormation и ресурсы Amazon Web Services, содержащие один и тот же тег Amazon Web Services. DevOps Guru может быть настроен для анализа ресурсов Amazon Web Services, определённых в стеках или помеченных тем же тегом ключ . Вы можете указать до 500 стеков Amazon Web Services CloudFormation.
См. также: Документацию API AWS
describe-resource-collection-health является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей, аргумент --query должен извлекать данные из результатов следующих выражений запроса: CloudFormation, Service, Tags
Синтаксис
describe-resource-collection-health
--resource-collection-type <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]
Параметры
--resource-collection-type (строка)
Тип коллекции ресурсов Amazon Web Services. Этот тип определяет, как определяются анализируемые ресурсы Amazon Web Services. Два поддерживаемых типа коллекций ресурсов Amazon Web Services — это стеки Amazon Web Services CloudFormation и ресурсы Amazon Web Services, содержащие один и тот же тег Amazon Web Services. DevOps Guru может быть настроен для анализа ресурсов Amazon Web Services, определённых в стеках или помеченных тем же тегом ключ . Вы можете указать до 500 стеков Amazon Web Services CloudFormation.
Возможные значения:
AWS_CLOUD_FORMATIONAWS_SERVICEAWS_TAGS
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной передачи. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов, которое необходимо вернуть в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной передачи укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS CLI.
--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.
Вывод
CloudFormation -> (список)
Возвращаемый CloudFormationHealthOverview объект, содержащий InsightHealthOverview объект с запрошенной информацией о состоянии системы.
(структура)
Информация о состоянии ресурсов Amazon Web Services в вашей учетной записи, определенных стеком Amazon Web Services CloudFormation.
StackName -> (строка)
Insight -> (структура)
Информация о состоянии ресурсов Amazon Web Services в вашей учетной записи, определенных стеком Amazon Web Services CloudFormation, включая количество открытых проактивных и реактивных инсайтов, а также среднее время восстановления (MTTR) закрытых инсайтов.
OpenProactiveInsights -> (целое число)
OpenReactiveInsights -> (целое число)
MeanTimeToRecoverInMilliseconds -> (длинное целое число)
AnalyzedResourceCount -> (длинное целое число)
Service -> (список)
Массив ServiceHealth объектов, описывающих состояние служб Amazon Web Services, связанных с ресурсами в коллекции.
(структура)
Представляет состояние службы Amazon Web Services.
ServiceName -> (строка)
Insight -> (структура)
Представляет состояние службы Amazon Web Services. Это ServiceInsightHealth, содержащий количество открытых проактивных и реактивных инсайтов для этой службы.
OpenProactiveInsights -> (целое число)
OpenReactiveInsights -> (целое число)
AnalyzedResourceCount -> (длинное целое число)
NextToken -> (строка)
Tags -> (список)
Теги Amazon Web Services, используемые ресурсами в коллекции ресурсов.
Теги помогают идентифицировать и организовывать ваши ресурсы Amazon Web Services. Многие службы Amazon Web Services поддерживают тегирование, поэтому вы можете назначить один и тот же тег ресурсам из разных служб, чтобы указать, что ресурсы связаны. Например, вы можете назначить один и тот же тег ресурсу таблицы Amazon DynamoDB, который вы назначаете функции Lambda. Для получения дополнительной информации об использовании тегов см. белый документ по рекомендациям по использованию тегов.
Каждый тег Amazon Web Services состоит из двух частей.
- Ключ тега (например,
CostCenter,Environment,ProjectилиSecret). Ключи тегов чувствительны к регистру. - Необязательное поле, известное как значение тега (например,
111122223333,Productionили имя команды). Пропуск значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру.
Вместе они известны как пары «ключ-значение».
Предупреждение
Строка, используемая для ключа тега, который вы используете для определения охвата ваших ресурсов, должна начинаться с префиксаDevops-guru- . Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application . При создании ключа регистр символов в ключе может быть любым. После создания ключ чувствителен к регистру. Например, DevOps Guru работает с ключом, имеющим имя devops-guru-rds, и ключом с именем DevOps-Guru-RDS, и эти ключи действуют как два разных ключа. Возможные пары «ключ-значение» в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.(структура)
Информация о состоянии ресурсов Amazon Web Services в вашей учетной записи, определенных ключом тега Amazon Web Services.
AppBoundaryKey -> (строка)
Ключ тега Amazon Web Services, используемый для идентификации ресурсов Amazon Web Services, которые анализирует DevOps Guru. Все ресурсы Amazon Web Services в вашей учетной записи и регионе, помеченные этим ключом, составляют границу приложения и анализа DevOps Guru.
Предупреждение
Строка, используемая для ключа тега, который вы используете для определения охвата ваших ресурсов, должна начинаться с префиксаDevops-guru- . Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application . При создании ключа регистр символов в ключе может быть любым. После создания ключ чувствителен к регистру. Например, DevOps Guru работает с ключом, имеющим имя devops-guru-rds, и ключом с именем DevOps-Guru-RDS, и эти ключи действуют как два разных ключа. Возможные пары «ключ-значение» в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.TagValue -> (строка)
Значение в теге Amazon Web Services.
Значение тега — это необязательное поле, используемое для присвоения строки ключу тега (например, 111122223333 , Production или имени команды). Ключ и значение образуют пару «ключ-значение» тега. Пропуск значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру. Вы можете указать не более 256 символов для значения тега.
Insight -> (структура)
Информация о состоянии ресурсов Amazon Web Services в вашей учетной записи, определенных тегом Amazon Web Services, включая количество открытых проактивных и реактивных инсайтов, а также среднее время восстановления (MTTR) закрытых инсайтов.
OpenProactiveInsights -> (целое число)
OpenReactiveInsights -> (целое число)
MeanTimeToRecoverInMilliseconds -> (длинное целое число)
AnalyzedResourceCount -> (длинное целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.