Spec-Zone.ru › AWS CLI v2

[ aws . route53resolver ]

list-resolver-query-log-configs

Описание

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

См. также: AWS API Documentation

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

Синтаксис

  list-resolver-query-log-configs
[--filters <value>]
[--sort-by <value>]
[--sort-order <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 (список)

Необязательное указание для возврата подмножества конфигураций ведения журналов запросов.

Примечание

Если вы отправляете второй или последующий запрос ListResolverQueryLogConfigs и указываете параметр NextToken, вы должны использовать те же значения для Filters, если таковые имеются, что и в предыдущем запросе.

(структура)

Для операций списка Resolver (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations и ListResolverDnssecConfigs) — необязательное указание для возврата подмножества объектов.

Для фильтрации объектов, таких как конечные точки Resolver или правила Resolver, вы указываете Name и Values. Например, чтобы отобразить только входящие конечные точки Resolver, укажите Direction для Name и укажите INBOUND для Values.

Имя -> (строка)

Имя параметра, который вы хотите использовать для фильтрации объектов.

Допустимые значения для Name зависят от действия, в которое включен фильтр, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs или ListResolverQueryLogConfigAssociations.

Примечание

В ранних версиях Resolver значения для Name были перечислены в верхнем регистре с разделителями подчеркивания (_). Например, CreatorRequestId изначально был указан как CREATOR_REQUEST_ID. Значения в верхнем регистре для Name по-прежнему поддерживаются.

ListResolverEndpoints

Допустимые значения для Name включают следующие:

  • CreatorRequestId: значение, которое вы указали при создании конечной точки Resolver.
  • Direction: указывает, хотите ли вы получить входящие или исходящие конечные точки Resolver. Если вы указали DIRECTION для Name, укажите INBOUND или OUTBOUND для Values.
  • HostVPCId: идентификатор VPC, через который входящие DNS-запросы проходят от вашей сети к вашим VPC в регионе, или VPC, через который исходящие запросы проходят от ваших VPC к вашей сети. В запросе CreateResolverEndpoint значение SubnetId косвенно идентифицирует VPC. В запросе GetResolverEndpoint идентификатор VPC для конечной точки Resolver возвращается в элементе HostVPCId.
  • IpAddressCount: количество IP-адресов, связанных с конечной точкой Resolver.
  • Name: имя конечной точки Resolver.
  • SecurityGroupIds: идентификаторы VPC-группы безопасности, которые вы указали при создании конечной точки Resolver.
  • Status: состояние конечной точки Resolver. Если вы указали Status для Name, укажите один из следующих кодов состояния для Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED или DELETING. Для получения дополнительной информации см. Status в ResolverEndpoint.
ListResolverRules

Допустимые значения для Name включают следующие:

  • CreatorRequestId: значение, которое вы указали при создании правила Resolver.
  • DomainName: доменное имя, для которого Resolver перенаправляет DNS-запросы в вашу сеть. В значении, которое вы указываете для Values, включите завершающую точку (.) после доменного имени. Например, если доменное имя — example.com, укажите следующее значение. Обратите внимание на «.» после com: example.com.
  • Name: имя правила Resolver.
  • ResolverEndpointId: идентификатор конечной точки Resolver, с которой связано правило Resolver.

Примечание

Вы можете фильтровать по конечной точке Resolver только для правил, имеющих значение FORWARD для RuleType.
  • Status: состояние правила Resolver. Если вы указали Status для Name, укажите один из следующих кодов состояния для Values: COMPLETE, DELETING, UPDATING или FAILED.
  • Type: тип правила Resolver. Если вы указали TYPE для Name, укажите FORWARD или SYSTEM для Values.
ListResolverRuleAssociations

Допустимые значения для Name включают следующие:

  • Name: имя ассоциации правил Resolver.
  • ResolverRuleId: идентификатор правила Resolver, связанного с одним или несколькими VPC.
  • Status: состояние ассоциации правила Resolver. Если вы указали Status для Name, укажите один из следующих кодов состояния для Values: CREATING, COMPLETE, DELETING или FAILED.
  • VPCId: идентификатор VPC, с которым связано правило Resolver.
ListResolverQueryLogConfigs

Допустимые значения для Name включают следующие:

  • Arn: ARN для конфигурации ведения журнала запросов.
  • AssociationCount: количество VPC, связанных с конфигурацией ведения журнала запросов.
  • CreationTime: дата и время создания конфигурации ведения журнала запросов в формате Unix и по Гринвичу (UTC).
  • CreatorRequestId: уникальная строка, идентифицирующая запрос, создавший конфигурацию ведения журнала запросов.
  • Destination: служба Amazon Web Services, в которую вы хотите перенаправить журналы запросов. Допустимые значения включают:
    • S3
    • CloudWatchLogs
    • KinesisFirehose
  • DestinationArn: ARN расположения, в которое Resolver отправляет журналы запросов. Это значение может быть ARN для ведра S3, группы журнала CloudWatch Logs или потока доставки Kinesis Data Firehose.
  • Id: идентификатор конфигурации ведения журнала запросов
  • Name: имя конфигурации ведения журнала запросов
  • OwnerId: идентификатор учетной записи Amazon Web Services для учетной записи, создавшей конфигурацию ведения журнала запросов.
  • ShareStatus: индикация того, совместна ли конфигурация ведения журнала запросов с другими учетными записями Amazon Web Services или была ли она совмещена с текущей учетной записью другой учетной записью Amazon Web Services. Допустимые значения включают: NOT_SHARED, SHARED_WITH_ME или SHARED_BY_ME.
  • Status: статус конфигурации ведения журнала запросов. Если вы указали Status для Name, укажите соответствующий код состояния для Values: CREATING, CREATED, DELETING или FAILED. Для получения дополнительной информации см. Статус.
ListResolverQueryLogConfigAssociations

Допустимые значения для Name включают следующие:

  • CreationTime: дата и время, когда VPC была связана с конфигурацией ведения журнала запросов, в формате Unix и по Гринвичу (UTC).
  • Error: если значение Status равно FAILED, укажите причину: DESTINATION_NOT_FOUND или ACCESS_DENIED.
  • Id: идентификатор ассоциации ведения журнала запросов.
  • ResolverQueryLogConfigId: идентификатор конфигурации ведения журнала запросов, с которой связан VPC.
  • ResourceId: идентификатор Amazon VPC, связанный с конфигурацией ведения журнала запросов.
  • Status: состояние ассоциации ведения журнала запросов. Если вы указали Status для Name, укажите соответствующий код состояния для Values: CREATING, CREATED, DELETING или FAILED. Для получения дополнительной информации см. Статус.

Значения -> (список)

При использовании операции List и необходимости возврата подмножества объектов, таких как конечные точки Resolver или правила Resolver, значение параметра, используемого для фильтрации объектов. Например, чтобы отобразить только входящие конечные точки Resolver, укажите Direction для Name и укажите INBOUND для Values.

(строка)

Упрощенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

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

--sort-by (строка)

Элемент, по которому вы хотите, чтобы Resolver сортировал конфигурации протоколирования запросов.

Примечание

Если вы отправляете второй или последующий запрос ListResolverQueryLogConfigs и указываете параметр NextToken, вы должны использовать то же значение для SortBy, если таковое имеется, что и в предыдущем запросе.

Допустимые значения включают следующие элементы:

  • Arn : ARN конфигурации протоколирования запросов
  • AssociationCount : Количество VPC, связанных с указанной конфигурацией
  • CreationTime : Дата и время, когда Resolver вернул конфигурацию при её создании
  • CreatorRequestId : Значение, указанное для CreatorRequestId при создании конфигурации
  • DestinationArn : Место назначения логов
  • Id : Идентификатор конфигурации
  • Name : Название конфигурации
  • OwnerId : Номер счета Amazon Web Services учетной записи, создавшей конфигурацию
  • ShareStatus : Является ли конфигурация совместной с другими учетными записями Amazon Web Services или с текущей учетной записью другой учетной записью Amazon Web Services. Совместное использование настраивается с помощью Resource Access Manager (RAM).
  • Status : Текущий статус конфигурации. Допустимые значения включают следующее:
    • CREATING : Resolver создаёт конфигурацию протоколирования запросов.
    • CREATED : Конфигурация протоколирования запросов успешно создана. Resolver протоколирует запросы, которые исходят из указанной VPC.
    • DELETING : Resolver удаляет эту конфигурацию протоколирования запросов.
    • FAILED : Resolver не смог создать или не смог удалить конфигурацию протоколирования запросов. Вот две распространённые причины:
      • Указанное место назначения (например, ведро Amazon S3) было удалено.
      • Разрешения не позволяют отправлять логи в место назначения.

--sort-order (строка)

Если вы указали значение для SortBy, порядок, в котором вы хотите отображать конфигурации протоколирования запросов, ASCENDING или DESCENDING.

Примечание

Если вы отправляете второй или последующий запрос ListResolverQueryLogConfigs и указываете параметр NextToken, вы должны использовать то же значение для SortOrder, если таковое имеется, что и в предыдущем запросе.

Возможные значения:

  • ASCENDING
  • DESCENDING

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 -> (строка)

Если конфигураций ведения журнала запросов больше, чем MaxResults, вы можете отправить другой запрос ListResolverQueryLogConfigs, чтобы получить следующую группу конфигураций. В следующем запросе укажите значение NextToken из предыдущего ответа.

TotalCount -> (целое число)

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

TotalFilteredCount -> (целое число)

Общее количество конфигураций ведения журнала запросов, созданных текущей учетной записью в указанном регионе и соответствующих фильтрам, указанным в запросе ListResolverQueryLogConfigs. Для общего количества конфигураций ведения журнала запросов, созданных текущей учетной записью в указанном регионе, см. TotalCount.

ResolverQueryLogConfigs -> (список)

Список, содержащий по одному элементу ResolverQueryLogConfig для каждой конфигурации ведения журнала запросов, соответствующей указанным значениям для Filter.

(структура)

В ответе на запрос CreateResolverQueryLogConfig , DeleteResolverQueryLogConfig , GetResolverQueryLogConfig или ListResolverQueryLogConfigs сложная структура, содержащая параметры для одной конфигурации ведения журнала запросов.

Id -> (строка)

Идентификатор конфигурации ведения журнала запросов.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services для учетной записи, создавшей конфигурацию ведения журнала запросов.

Status -> (строка)

Статус указанной конфигурации ведения журнала запросов. Допустимые значения включают:

  • CREATING : Resolver создает конфигурацию ведения журнала запросов.
  • CREATED : Конфигурация ведения журнала запросов успешно создана. Resolver регистрирует запросы, исходящие из указанной сети VPC.
  • DELETING : Resolver удаляет эту конфигурацию ведения журнала запросов.
  • FAILED : Resolver не может передать журналы в указанное расположение в конфигурации ведения журнала запросов. Вот две распространенные причины:
    • Указанный пункт назначения (например, ведро Amazon S3) был удален.
    • Разрешения не позволяют отправлять журналы в пункт назначения.

ShareStatus -> (строка)

Указание на то, делится ли конфигурация ведения журнала запросов с другими учетными записями Amazon Web Services или была разделена с текущей учетной записью другой учетной записью Amazon Web Services. Обмен настраивается через Resource Access Manager (RAM).

AssociationCount -> (целое число)

Количество сетей VPC, связанных с конфигурацией ведения журнала запросов.

Arn -> (строка)

ARN для конфигурации ведения журнала запросов.

Name -> (строка)

Имя конфигурации ведения журнала запросов.

DestinationArn -> (строка)

ARN ресурса, который Resolver должен отправлять журналы запросов: ведро Amazon S3, группу журналов CloudWatch Logs или поток доставки Kinesis Data Firehose.

CreatorRequestId -> (строка)

Уникальная строка, идентифицирующая запрос, создавший конфигурацию ведения журнала запросов. CreatorRequestId позволяет повторно отправлять неудачные запросы без риска выполнения операции дважды.

CreationTime -> (строка)

Дата и время создания конфигурации ведения журнала запросов в формате Unix time и по Гринвичу (UTC).

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

Spec-Zone.ru

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