list-coverage
Описание
Отображает сведения о покрытии для вашей учетной записи GuardDuty. Если вы администратор GuardDuty, вы можете получить доступ ко всем ресурсам, связанным с активными учетными записями-членами вашей организации.
Убедитесь, что в учетных записях включен мониторинг в реальном времени и агент GuardDuty запущен на их ресурсах.
См. также: Документацию API AWS
list-coverage — это операция с постраничной передачей. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлечь данные из результатов следующих выражений запроса: Resources
Синтаксис
list-coverage
--detector-id <value>
[--filter-criteria <value>]
[--sort-criteria <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]
Параметры
--detector-id (строка)
Уникальный идентификатор детектора, сведения о покрытии которого вы хотите получить.
Чтобы найти detectorId в текущем регионе, см. страницу Настройки в консоли GuardDuty или выполните API ListDetectors.
--filter-criteria (структура)
Представляет критерии, используемые для фильтрации сведений о покрытии.
FilterCriterion -> (список)
Представляет условие, которое при совпадении добавляется в ответ операции.
(структура)
Представляет условие, которое при совпадении добавляется в ответ операции.
CriterionKey -> (строка)
Значение перечисления, представляющее возможные поля фильтра.
Примечание
Замените значение перечисленияCLUSTER_NAME на EKS_CLUSTER_NAME. CLUSTER_NAME устарел.FilterCondition -> (структура)
Содержит информацию об условии.
Equals -> (список)
Представляет условие равенства, которое применяется к одному полю при получении сведений о покрытии.
(строка)
NotEquals -> (список)
Представляет условие неравенства, которое применяется к одному полю при получении сведений о покрытии.
(строка)
Синтаксис JSON:
{
"FilterCriterion": [
{
"CriterionKey": "ACCOUNT_ID"|"CLUSTER_NAME"|"RESOURCE_TYPE"|"COVERAGE_STATUS"|"ADDON_VERSION"|"MANAGEMENT_TYPE"|"EKS_CLUSTER_NAME"|"ECS_CLUSTER_NAME"|"AGENT_VERSION"|"INSTANCE_ID"|"CLUSTER_ARN",
"FilterCondition": {
"Equals": ["string", ...],
"NotEquals": ["string", ...]
}
}
...
]
}
--sort-criteria (структура)
Представляет критерии, используемые для сортировки сведений о покрытии.
AttributeName -> (строка)
Представляет имя поля, используемого для сортировки сведений о покрытии.
Примечание
Замените значение перечисленияCLUSTER_NAME на EKS_CLUSTER_NAME. CLUSTER_NAME устарел.OrderBy -> (строка)
Краткая форма синтаксиса:
AttributeName=string,OrderBy=string
Синтаксис JSON:
{
"AttributeName": "ACCOUNT_ID"|"CLUSTER_NAME"|"COVERAGE_STATUS"|"ISSUE"|"ADDON_VERSION"|"UPDATED_AT"|"EKS_CLUSTER_NAME"|"ECS_CLUSTER_NAME"|"INSTANCE_ID",
"OrderBy": "ASC"|"DESC"
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной передачи. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы, получаемой при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная передача в руководстве пользователя 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
- текст
- таблица
- 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.
Вывод
Ресурсы -> (список)
Список ресурсов и их атрибутов, предоставляющих данные о кластере.
(структура)
Информация о ресурсе учетной записи GuardDuty.
ResourceId -> (строка)
DetectorId -> (строка)
AccountId -> (строка)
ResourceDetails -> (структура)
Информация о ресурсе, для которого извлекаются статистические данные о покрытии.
EksClusterDetails -> (структура)
Детали кластера EKS, участвующие в статистике покрытия.
ClusterName -> (строка)
CoveredNodes -> (длинное целое число)
HEALTHY.CompatibleNodes -> (длинное целое число)
AddonDetails -> (структура)
Информация об установленных дополнениях EKS.
AddonVersion -> (строка)
AddonStatus -> (строка)
ManagementType -> (строка)
Указывает, как агент Amazon EKS add-on GuardDuty управляется для данного кластера EKS.
AUTO_MANAGED указывает, что GuardDuty развертывает и управляет обновлениями для данного ресурса.
MANUAL указывает, что вы несете ответственность за развертывание, обновление и управление агентом Amazon EKS add-on GuardDuty для данного ресурса.
ResourceType -> (строка)
EcsClusterDetails -> (структура)
Информация о кластере Amazon ECS, который оценивается на предмет покрытия в режиме выполнения.
ClusterName -> (строка)
FargateDetails -> (структура)
Информация о параметрах Fargate, связанных с кластером Amazon ECS.
Issues -> (список)
Проблемы покрытия в режиме выполнения, выявленные для ресурса, работающего в Amazon Web Services Fargate.
(строка)
ManagementType -> (строка)
Указывает, как агент безопасности GuardDuty управляется для данного ресурса.
-
AUTO_MANAGEDуказывает, что GuardDuty развертывает и управляет обновлениями для этого ресурса. -
DISABLEDуказывает, что развертывание агента безопасности GuardDuty отключено для этого ресурса.
Примечание
СтатусMANUAL не применяется к рабочим нагрузкам Amazon Web Services Fargate (только Amazon ECS).ContainerInstanceDetails -> (структура)
Информация об контейнере Amazon ECS, работающем на экземпляре Amazon EC2.
CoveredContainerInstances -> (длинное целое число)
HEALTHY.CompatibleContainerInstances -> (длинное целое число)
Ec2InstanceDetails -> (структура)
Информация об экземпляре Amazon EC2, оцененном на предмет покрытия в режиме выполнения.
InstanceId -> (строка)
InstanceType -> (строка)
ClusterArn -> (строка)
AgentDetails -> (структура)
Информация об установленных агентах безопасности.
Version -> (строка)
ManagementType -> (строка)
Указывает, как агент безопасности GuardDuty управляется для данного ресурса.
-
AUTO_MANAGEDуказывает, что GuardDuty развертывает и управляет обновлениями для этого ресурса. -
MANUALуказывает, что вы отвечаете за развертывание, обновление и управление обновлениями агента безопасности GuardDuty для этого ресурса.
Примечание
СтатусDISABLED не применяется к экземплярам Amazon EC2 и кластерам Amazon EKS.CoverageStatus -> (строка)
Issue -> (строка)
UNHEALTHY для кластера EKS.UpdatedAt -> (метка времени)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.