[ aws . devops-guru ]
describe-organization-resource-collection-health
Описание
Предоставляет обзор состояния вашей системы. Если дополнительные учетные записи участников являются частью вашей организации, вы можете отфильтровать эти учетные записи, используя поле AccountIds.
См. также: Документацию API AWS
describe-organization-resource-collection-health — это постраничный запрос. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную навигацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: CloudFormation, Account, Service, Tags
Синтаксис
describe-organization-resource-collection-health
--organization-resource-collection-type <value>
[--account-ids <value>]
[--organizational-unit-ids <value>]
[--max-results <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]
Параметры
--organization-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_ACCOUNTAWS_TAGS
--account-ids (список)
Идентификатор учетной записи Amazon Web Services.
(строка)
Синтаксис:
"string" "string" ...
--organizational-unit-ids (список)
Идентификатор организационной единицы.
(строка)
Синтаксис:
"string" "string" ...
--max-results (целое число)
nextToken.--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения будут переопределять значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с использованием значения, предоставленного JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничного отображения. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя командной строки AWS.
--max-items (целое число)
Общее количество элементов, подлежащих возврату в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной навигации предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя командной строки AWS.
--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.
Вывод
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 -> (длинное целое число)
Account -> (список)
Имя учетной записи организации.
(структура)
Возвращает количество открытых реактивных инсайтов, количество открытых проактивных инсайтов и количество проанализированных метрик в вашей учетной записи Amazon Web Services. Используйте эти числа для оценки состояния операций в вашей учетной записи Amazon Web Services.
AccountId -> (строка)
Insight -> (структура)
Информация о состоянии ресурсов Amazon Web Services в вашей учетной записи, включая количество открытых проактивных и реактивных инсайтов, а также среднее время восстановления (MTTR) закрытых инсайтов.
OpenProactiveInsights -> (целое число)
OpenReactiveInsights -> (целое число)
NextToken -> (строка)
Tags -> (список)
Теги помогают вам идентифицировать и организовывать ваши ресурсы 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.