Spec-Zone.ru › AWS CLI v2

[ aws . amp ]

list-scrapers

Описание

Операция ListScrapers перечисляет все созданные или удалённые сборщики данных в вашем аккаунте. Вы можете необязательно отфильтровать возвращаемый список.

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

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

Синтаксис

  list-scrapers
[--filters <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]

Параметры

--filters (массив)

(Необязательно) Список пар ключ-значение для фильтрации списка сборщиков данных, возвращаемых в результате запроса. Ключи включают status , sourceArn , destinationArn и alias .

Фильтры по одному и тому же ключу OR , а фильтры по различным ключам — AND . Например, status=ACTIVE&status=CREATING&alias=Test вернёт все сборщики данных, у которых псевдоним равен Test, и которые находятся в статусе ACTIVE или CREATING.

Для поиска всех активных сборщиков данных, отправляющих метрики в определённый рабочий стол Amazon Managed Service for Prometheus, нужно использовать ARN рабочего стола в запросе:

status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

Если этот параметр указан, результаты будут отфильтрованы, оставив только соответсвующие сборщики данных.

key -> (строка)

Имя ключа для фильтрации. В настоящее время поддерживаются ключи фильтрации status , sourceArn , destinationArn и alias .

value -> (список)

Значения заданного ключа для фильтрации.

(строка)

Значение заданного ключа для фильтрации.

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

KeyName1=string,string,KeyName2=string,string

Синтаксис JSON:

{"string": ["string", ...]
  ...}

--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
  • 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.

Вывод

nextToken -> (строка)

Токен, указывающий, что для получения есть больше результатов. Вы можете использовать этот токен в следующей операции ListScrapers для получения этих результатов.

scrapers -> (список)

Список структур ScraperSummary, предоставляющих информацию о сборщиках данных в аккаунте, соответствующих указанным фильтрам.

(структура)

Структура ScraperSummary содержит сводку данных об одном сборщике данных в вашем аккаунте.

alias -> (строка)

(Необязательно) Имя, связанное со сборщиком данных.

arn -> (строка)

Amazon Resource Name (ARN) сборщика данных.

createdAt -> (метка времени)

Дата и время создания сборщика данных.

destination -> (структура помеченного союза)

Рабочий стол Amazon Managed Service for Prometheus, в который отправляются метрики сборщика данных.

Примечание

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

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

Рабочий стол Amazon Managed Service for Prometheus для отправки метрик.

workspaceArn -> (строка)

ARN рабочего стола Amazon Managed Service for Prometheus.

lastModifiedAt -> (метка времени)

Дата и время последнего изменения сборщика данных.

roleArn -> (строка)

Amazon Resource Name (ARN) IAM-роли, предоставляющей разрешения сборщику данных для обнаружения и сбора метрик от вашего имени.

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

Эта структура отображает информацию о IAM-ролях, используемых для конфигурации межаккаунтового сбора данных.

sourceRoleArn -> (строка)

Amazon Resource Name (ARN) роли, используемой в исходном аккаунте для включения межаккаунтового сбора данных. Подробности этой политики см. в разделе Настройка межаккаунтовой настройки .

targetRoleArn -> (строка)

Amazon Resource Name (ARN) роли, используемой в целевом аккаунте для включения межаккаунтового сбора данных. Подробности этой политики см. в разделе Настройка межаккаунтовой настройки .

scraperId -> (строка)

Идентификатор сборщика данных.

source -> (структура помеченного союза)

Amazon EKS-кластер, из которого сборщик данных собирает метрики.

Примечание

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

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

Amazon EKS-кластер, из которого сборщик данных собирает метрики.

clusterArn -> (строка)

ARN Amazon EKS-кластера.

securityGroupIds -> (список)

Список идентификаторов групп безопасности для конфигурации VPC Amazon EKS-кластера.

(строка)

Идентификатор группы безопасности VPC.

subnetIds -> (список)

Список идентификаторов подсетей для конфигурации VPC Amazon EKS-кластера.

(строка)

Идентификатор подсети VPC.

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

Структура, содержащая текущий статус сборщика данных.

statusCode -> (строка)

Текущий статус сборщика данных.

statusReason -> (строка)

При наличии ошибки, причина ошибки.

tags -> (массив)

(Необязательно) Список ключей и значений тегов, связанных со сборщиком данных.

key -> (строка)

Ключ тега. Не должен начинаться с aws: .

value -> (строка)

Значение тега.

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

Spec-Zone.ru

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