get-distributions

Описание

Возвращает информацию об одной или нескольких распределениях вашей сети доставки контента (CDN) Amazon Lightsail.

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

Синтаксис

  get-distributions
[--distribution-name <value>]
[--page-token <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]

Параметры

--distribution-name (строка)

Имя распределения, для которого требуется вернуть информацию.

Если параметр опущен, в ответе будут указаны все ваши распределения в регионе Amazon Web Services, где выполняется запрос.

--page-token (строка)

Токен для перехода к следующей странице результатов запроса.

Для получения токена страницы выполните начальный запрос GetDistributions. Если результаты запроса разбиты на страницы, ответ вернет токен следующей страницы, который можно указать как токен страницы в последующем запросе.

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

Вывод

distributions -> (список)

Массив объектов, описывающих ваши распределения.

(структура)

Описание распределения сети доставки контента (CDN) Amazon Lightsail.

name -> (строка)

Название распределения.

arn -> (строка)

Amazon Resource Name (ARN) распределения.

supportCode -> (строка)

Код поддержки. Укажите этот код в своем письме в службу поддержки, если у вас есть вопросы о вашем распределении Lightsail. Этот код позволит нашей команде поддержки легче найти вашу информацию о Lightsail.

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

Метка времени создания распределения.

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

Объект, описывающий расположение распределения, например, регион и зону доступности Amazon Web Services.

Примечание

Распределения Lightsail являются глобальными ресурсами, которые могут ссылаться на источник в любом регионе Amazon Web Services и распределять его контент по всему миру. Однако все распределения расположены в регионе us-east-1.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail (Distribution).

alternativeDomainNames -> (список)

Альтернативные доменные имена распределения.

(строка)

status -> (строка)

Состояние распределения.

isEnabled -> (булево)

Указывает, включено ли распределение.

domainName -> (строка)

Доменное имя распределения.

bundleId -> (строка)

Идентификатор пакета, который в настоящее время применен к распределению.

certificateName -> (строка)

Название сертификата SSL/TLS, прикрепленного к распределению, если таковой имеется.

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

Объект, описывающий исходный ресурс распределения, например, экземпляр Lightsail, хранилище или балансировщик нагрузки.

Распределение получает, кэширует и предоставляет контент из источника.

name -> (строка)

Название исходного ресурса.

resourceType -> (строка)

Тип ресурса исходного ресурса (Экземпляр).

regionName -> (строка)

Имя региона AWS исходного ресурса.

protocolPolicy -> (строка)

Протокол, который использует ваше распределение Amazon Lightsail при установлении соединения с источником для получения контента.

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

Количество времени в секундах, которое распределение ожидает ответа после переадресации запроса к источнику. Минимальное время ожидания - 1 секунда, максимальное - 60 секунд, а по умолчанию (если вы не укажете иначе) - 30 секунд.

originPublicDNS -> (строка)

Публичный DNS источника.

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

Объект, описывающий поведение кэширования по умолчанию распределения.

behavior -> (строка)

Поведение кэширования распределения.

Можно указать следующие виды поведения кэширования:

**cache ** - Этот вариант лучше всего подходит для статических сайтов. При указании этого значения распределение кэширует и предоставляет весь ваш веб-сайт как статический контент. Это поведение идеально подходит для веб-сайтов со статическим контентом, который не меняется в зависимости от того, кто его просматривает, или для веб-сайтов, которые не используют cookie, заголовки или строки запроса для персонализации контента.
**dont-cache ** - Этот вариант лучше всего подходит для сайтов, которые предоставляют как статический, так и динамический контент. При указании этого значения распределение кэширует и предоставляет только тот контент, который указан в параметре CacheBehaviorPerPath распределения. Это поведение идеально подходит для веб-сайтов или веб-приложений, которые используют cookie, заголовки и строки запроса для персонализации контента для отдельных пользователей.

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

Объект, описывающий настройки поведения кэширования распределения.

defaultTTL -> (длинное целое)

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

Примечание

Указанное значение применяется только в том случае, если источник не добавляет HTTP-заголовки, такие как Cache-Control max-age , Cache-Control s-maxage и Expires к объектам.

minimumTTL -> (длинное целое)

Минимальное время, в течение которого объекты хранятся в кэше распределения, прежде чем распределение направит еще один запрос к источнику, чтобы определить, был ли объект обновлен.

Значение 0 должно быть указано для minimumTTL, если распределение настроено на пересылку всех заголовков источнику.

maximumTTL -> (длинное целое)

Максимальное время, в течение которого объекты хранятся в кэше распределения, прежде чем распределение направит еще один запрос к источнику, чтобы определить, был ли объект обновлен.

Указанное значение применяется только в том случае, если источник добавляет HTTP-заголовки, такие как Cache-Control max-age , Cache-Control s-maxage и Expires к объектам.

allowedHTTPMethods -> (строка)

HTTP-методы, которые обрабатываются и пересылаются в источник распределения.

Вы можете указать следующие варианты:

GET,HEAD - Распределение пересылает методы GET и HEAD.
GET,HEAD,OPTIONS - Распределение пересылает методы GET , HEAD и OPTIONS.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - Распределение пересылает методы GET , HEAD , OPTIONS , PUT , PATCH , POST и DELETE.

Если вы выберете третий вариант, вам может потребоваться ограничить доступ к источнику вашего распределения, чтобы пользователи не могли выполнять операции, которые вы не хотите им разрешать. Например, вы можете не разрешить пользователям удалять объекты из источника.

cachedHTTPMethods -> (строка)

Ответы HTTP-методов, которые кэшируются вашим распределением.

Вы можете указать следующие варианты:

GET,HEAD - Распределение кэширует ответы на методы GET и HEAD.
GET,HEAD,OPTIONS - Распределение кэширует ответы на методы GET , HEAD и OPTIONS.

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

Объект, описывающий cookie, которые пересылаются источнику. Ваш контент кэшируется на основе пересылаемых cookie.

option -> (строка)

Указывает, какие cookie пересылать источнику распределения для поведения кэширования: all , none или allow-list для пересылки только cookie, указанных в параметре cookiesAllowList.

cookiesAllowList -> (список)

Конкретные cookie, которые пересылать в источник распределения.

(строка)

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

Объект, описывающий заголовки, которые пересылаются в источник. Ваш контент кэшируется на основе пересылаемых заголовков.

option -> (строка)

Заголовки, которые вы хотите, чтобы ваше распределение пересылало в источник и на основе которых должно осуществляться кэширование.

Вы можете настроить распределение следующим образом:

**all ** - Переслать все заголовки в источник.
**none ** - Переслать только стандартные заголовки.
**allow-list ** - Переслать только те заголовки, которые вы указали с помощью параметра headersAllowList.

headersAllowList -> (список)

Конкретные заголовки, которые пересылать в источник распределения.

(строка)

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

Объект, описывающий строки запросов, которые пересылаются в источник. Ваш контент кэшируется на основе пересылаемых строк запросов.

option -> (булево)

Указывает, пересылает ли распределение строки запросов и кэширует их на основе них.

queryStringsAllowList -> (список)

Конкретные строки запросов, которые распределение пересылает в источник.

Распределение будет кэшировать контент на основе указанных строк запросов.

Если параметр option имеет значение true, то распределение пересылает все строки запросов, независимо от того, что вы указали с помощью параметра queryStringsAllowList.

(строка)

cacheBehaviors -> (список)

Массив объектов, описывающих поведение кэширования по пути для распределения.

(структура)

Описывает поведение кэширования по пути для распределения Amazon Lightsail Content Delivery Network (CDN).

Поведение кэширования по пути используется для переопределения или добавления исключения к стандартному поведению кэширования распределения. Например, если cacheBehavior установлено на cache, то поведение кэширования по пути может быть использовано для указания каталога, файла или типа файла, которые будет кэшировать распределение. В противном случае, если cacheBehavior распределения установлено на dont-cache, то поведение кэширования по пути может быть использовано для указания каталога, файла или типа файла, которые распределение не будет кэшировать.

path -> (строка)

Путь к каталогу или файлу, который нужно кэшировать или не кэшировать. Используйте символ звездочки для указания подстановочных каталогов (path/to/assets/*) и типов файлов (*.html, *jpg, *js). Каталоги и пути к файлам чувствительны к регистру.

Примеры:

Укажите следующее, чтобы кэшировать все файлы в корневом каталоге веб-сервера Apache, работающего на экземпляре Lightsail. var/www/html/
Укажите следующий файл, чтобы кэшировать только страницу индекса в корневом каталоге веб-сервера Apache. var/www/html/index.html
Укажите следующее, чтобы кэшировать только файлы с расширением .html в корневом каталоге веб-сервера Apache. var/www/html/*.html
Укажите следующее, чтобы кэшировать только файлы с расширениями .jpg, .png и .gif в подкаталоге images корневого каталога веб-сервера Apache. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Укажите следующее, чтобы кэшировать все файлы в подкаталоге images корневого каталога веб-сервера Apache. var/www/html/images/

behavior -> (строка)

Поведение кэширования для указанного пути.

Вы можете указать одно из следующих поведений кэширования по пути:

**cache ** - Это поведение кэширует указанный путь.
**dont-cache ** - Это поведение не кэширует указанный путь.

ableToUpdateBundle -> (логическое значение)

Указывает, можно ли изменить пакет, который в настоящее время применен к вашему распределению, указанный с помощью параметра distributionName, на другой пакет.

Используйте действие UpdateDistributionBundle для изменения пакета вашего распределения.

ipAddressType -> (строка)

Тип IP-адреса распределения.

Возможные значения: ipv4 для только IPv4 и dualstack для IPv4 и IPv6.

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

(структура)

Описывает ключ тега и необязательное значение, назначенные ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

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

Ограничения: Значения тегов принимают максимум 256 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

viewerMinimumTlsProtocolVersion -> (строка)

Минимальная версия протокола TLS, которую распределение может использовать для связи со зрителями.

nextPageToken -> (строка)

Токен для перехода к следующей странице результатов вашего запроса.

Токен следующей страницы не возвращается, если больше результатов отображать не нужно.

Чтобы получить следующую страницу результатов, выполните еще один запрос GetDistributions и укажите токен следующей страницы с помощью параметра pageToken.

END_OF_DOCUMENT_MARKER