Spec-Zone.ru › AWS CLI v2

[ aws . amp ]

описание-скрейпера

Описание

Операция DescribeScraper отображает информацию об существующем скрейпере.

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

Синтаксис

  describe-scraper
--scraper-id <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--scraper-id (строка)

Идентификатор скрейпера для описания.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Вывод

скрейпер -> (структура)

Содержит подробную информацию о скрейпере.

псевдоним -> (строка)

(Необязательно) Название, связанное со скрейпером.

arn -> (строка)

Amazon Resource Name (ARN) скрейпера. Например, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34.

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 роли, предоставляющей разрешения скрейперу для обнаружения и сбора метрик от вашего имени.

Например, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example.

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

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

sourceRoleArn -> (строка)

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

targetRoleArn -> (строка)

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

scrapeConfiguration -> (структура помеченного объединения)

Конфигурация, используемая скрейпером.

Примечание

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

configurationBlob -> (двоичные данные)

Закодированный в base64 файл конфигурации скрейпинга.

scraperId -> (строка)

Идентификатор скрейпера. Например, s-example1-1234-abcd-5678-ef9012abcd34.

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 -> (карта)

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

ключ -> (строка)

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

значение -> (строка)

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

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

Spec-Zone.ru

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