обработка кромок CLI

Интерфейс командной строки EdgeWorkers

Интерфейс командной строки EdgeWorkers Интерфейс командной строки (CLI) EdgeWorkers ускоряет процесс регистрации, загрузки, активации и тестирования функций EdgeWorkers в сети Akamai Edge.

Перейдите в интерфейс командной строки Akamai для EdgeKV, чтобы получить информацию о том, как управлять базами данных EdgeKV и вызывать API EdgeKV из командной строки.

Требования к технической настройке

Чтобы использовать этот инструмент, вам необходимо:

• Akamai CLI установлен.

• Если у вас нет интерфейса командной строки и вы используете Homebrew на Mac, выполните следующую команду: brew install akamai

• Вы также можете загрузить двоичные файлы CLI для конкретной ОС или образ Docker.

• Действительные учетные данные EdgeGrid, настроенные через Центр управления Akamai (см. раздел «Начало работы с API»).

• Версия узла 14 или выше

Установите или обновите EdgeWorkers

• Если у вас не установлен пакет EdgeWorkers CLI, используйте следующую команду Akamai CLI для установки последней версии пакета EdgeWorkers CLI:

Использование:
akamai install edgeworkers

• Если у вас уже установлен интерфейс командной строки, используйте следующую команду интерфейса командной строки Akamai, чтобы установить последний пакет интерфейса командной строки EdgeWorkers, включающий функции EdgeKV:

Использование:
akamai update edgeworkers

Предоставление свойств конфигурации по умолчанию

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

1. Создайте файл конфигурации ~/.akamai-cli/ew-config и сохраните свойства следующим образом:

 [по умолчанию]
EdgeworkerName = testEW
идентификатор группы=12345
идентификатор версии=1-0-2

2. Используйте команду config , чтобы установить свойства по умолчанию: akamai edgeworkers config set

Здесь отображаются доступные имена свойств.

Обзор команд

Интерфейс командной строки EdgeWorkers позволяет управлять функциями EdgeWorkers путем вызова API EdgeWorkers.

Соглашения:

• необязательные аргументы []

• обязательные аргументы <>

Использование:
akamai edgeworkers [options] [command]

Параметры:

Синтаксис	Описание
-V, --версия	Отобразите номер версии программы EdgeWorkers CLI.
--отлаживать	Показать отладочную информацию.
--edgerc	Используйте учетные данные в файле edgerc для команды. (Расположение файла по умолчанию — ~/.edgerc )
--section	Используйте этот раздел в файле edgerc . (Раздел по умолчанию — [default] )
--configSection	Используйте этот раздел в файле ew-config , который содержит набор свойств конфигурации по умолчанию. (Раздел по умолчанию — [default] )
--timeout	Вы можете указать значение тайм-аута для команды в секундах, чтобы переопределить значение по умолчанию, равное 2 минутам. Например, если вы добавите к команде «--timeout 10», время ожидания истечет, если серверу потребуется более 10 секунд для ответа.
--json [path]	Запишите выходные данные CLI в формате JSON по дополнительно предоставленному пути. Если путь не указан, запишите вывод JSON в домашний каталог CLI.
--jsonout	Запишите вывод CLI в формате JSON на стандартный вывод.
-х, --help	Отображение информации об использовании EdgeWorkers CLI.

Команды:

Команда | Псевдоним	Описание
помочь [command]	Отображение информации об использовании данной команды.
группы списков | lg [group-identifier]	Разработчик клиента может найти свой уровень доступа EdgeWorkers для каждой группы управления доступом Luna.
идентификаторы списка | li [options] [edgeworker-identifier]	Вывести список идентификаторов EdgeWorker, зарегистрированных в данный момент.
зарегистрироваться | create-id	Зарегистрируйте новый идентификатор EdgeWorker, который будет использоваться в поведении Property Manager.
идентификатор обновления | ui [options]	Позволяет разработчику клиента обновлять атрибуты Luna ACG или имени существующего идентификатора EdgeWorker.
удалить идентификатор | delete-id [options]	Полностью удалите существующий идентификатор EdgeWorker.
список-версий | lv [version-identifier]	Получение списка информации о версии для данного идентификатора EdgeWorker.
загрузить | create-version [options]	Создает новую версию заданного идентификатора EdgeWorker, которая включает пакет кода.
удалить-версию | удалить-версию [options]	Безвозвратно удалить существующую версию данного идентификатора EdgeWorker.
скачать | версия-загрузки [options]	Загрузите пакет кода версии EdgeWorker.
скачать-редактировать | dr [options]	Загрузите объединенный пакет кода, содержащий код и зависимости, которые выполняет EdgeWorker.
статус | list-activations [options]	Получение списка статуса активации для данного идентификатора EdgeWorker.
список изменений | lr [options]	Перечислите историю изменений для данного идентификатора EdgeWorker.
получить-пересмотр | gr	Получите подробную информацию о конкретной версии.
сравнение-ревизий | cr <идентификатор	Просмотр различий в зависимостях между двумя версиями одного и того же EdgeWorker.
активировать-ревизию | ar [options]	Активируйте версию для данного идентификатора EdgeWorker в сети Akamai.
pin-revision [options]	Закрепите активную редакцию для данного идентификатора EdgeWorker.
unpin-revision [options]	Открепите активную закрепленную редакцию для данного идентификатора EdgeWorker.
получить-ревизию-бом | gb [options]	Просмотр сведений о конкретной версии составного пакета.
список-ревизий-активаций | lra [options]	Получение списка статуса активации версии для данного идентификатора EdgeWorker.
активировать | av	Активируйте версию для данного идентификатора EdgeWorker в сети Akamai.
деактивировать | deact	Деактивируйте версию для данного идентификатора EdgeWorker в сети Akamai.
подтвердить | вв	Проверяет версию пакета кода без загрузки пакета кода.
создать токен-аутентификации | аутентификация [options]	Создает токен аутентификации, который можно использовать для получения подробных заголовков ответов отладки EdgeWorker. Для запуска этой команды вам потребуется интерфейс командной строки EdgeWorkers не ниже 1.7.1.
клон | clone [options]	Клонирует EdgeWorker из существующего идентификатора EdgeWorker.
список-контрактов | li-контракты [options]	Список идентификаторов контрактов, к которым у пользователя есть доступ.
список-свойств | lp [options]	Список свойств, связанных с данным идентификатором EdgeWorker.
ограничения списка | Li-пределы	Просмотрите различные ограничения, которые EdgeWorkers накладывает на количество активаций, идентификаторы EdgeWorkers и версии, которые вы можете развернуть.
списки-рестьеры | li-restiers [options]	Перечислите уровни ресурсов, которые можно использовать для создания или клонирования идентификатора EdgeWorker.
шоу-рестьер | show-restier	Клиенты могут получить сведения об уровне ресурсов для определенного идентификатора EdgeWorker.
получать отчеты	Получите список всех доступных отчетов EdgeWorkers.
получить отчет [options]	Получите отчет EdgeWorkers для определенного идентификатора EdgeWorker.
список конфигурации	Получите все значения в файле конфигурации.
конфиг получить	Получите значение конфигурации из раздела файла конфигурации.
набор конфигурации	Установите значение конфигурации в разделе.
config save -p	Сохраните свойства конфигурации в разделе.
конфигурация отключена	Удалите значение конфигурации в разделе.

Получение списка групп разрешений с доступом EdgeWorkers

Разработчик клиента может найти свой уровень доступа EdgeWorkers для каждой группы управления доступом Luna.

Использование: akamai edgeworkers list-groups [options] [group-identifier]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор группы	необязательный	Значение группы доступа Luna (обычно номер) для проверки разрешений EdgeWorkers.

Ключевые детали

1. Вывод фильтруется только для тех групп управления доступом Luna, которые имеют хотя бы одну возможность EdgeWorkers.

2. Возможности могут быть следующими: VIEW,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE.

Получение списка существующих идентификаторов EdgeWorker

Вывести список идентификаторов EdgeWorker, зарегистрированных в данный момент.

Использование: akamai edgeworkers list-ids [options] [edgeworker-identifier]

Вариант	Описание
-х, --help	вывод информации об использовании
--groupId	Фильтрация списка идентификаторов EdgeWorker по группе разрешений
--resourceTierId	Фильтрация идентификатора EdgeWorker по уровню ресурсов

Аргумент	Существование	Описание
идентификатор EdgeWorker	необязательный	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.

Зарегистрируйте новый идентификатор EdgeWorker

Зарегистрируйте новый идентификатор EdgeWorker, который будет использоваться в поведении Property Manager.

Использование: akamai edgeworkers register [options]

Вариант	Описание
--resourceTierId	Новый идентификатор уровня ресурсов, с которым будет связан EdgeWorker.
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор группы	необходимый	Значение группы доступа Luna (обычно номер) для проверки разрешений EdgeWorkers.
имя кромкообработчика	необходимый	Читаемая человеком короткая метка, описывающая экземпляр EdgeWorkers.

Ключевые детали

1. В заголовке ответа о местоположении будет указан новый идентификатор EdgeWorker.

2. В тексте ответа с данными идентификатора EdgeWorker (JSON) будет указан код ответа 201.

3. Чтобы отключить запросы в целях автоматизации, в качестве входных данных можно указать «resourceTierId».

Обновить информацию идентификатора EdgeWorker

Позволяет разработчику клиента обновлять атрибуты Luna ACG или имени существующего идентификатора EdgeWorker.

Использование: akamai edgeworkers update-id [options]

Вариант	Описание
--resourceTierId	Новый идентификатор уровня ресурсов, с которым будет связан EdgeWorker.
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор группы	необходимый	Значение группы доступа Luna (обычно номер) для проверки разрешений EdgeWorkers.
имя кромкообработчика	необходимый	Читаемая человеком короткая метка, описывающая экземпляр EdgeWorkers.

Ключевые детали

1. API требует, чтобы были указаны и идентификатор группы, и имя, даже если изменяется только один из этих атрибутов.

2. В тексте ответа с данными идентификатора EdgeWorker (JSON) будет указан код ответа 200.

3. Предоставленный идентификатор уровня ресурса должен совпадать с тем, который уже есть у идентификатора EdgeWorker. Чтобы предоставить другой идентификатор уровня ресурсов, используйте операцию клонирования.

Удалить существующий идентификатор EdgeWorker

Полностью удалите существующий идентификатор EdgeWorker.

Использование: akamai edgeworkers delete-id [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--noPrompt	Пропустить запрос на подтверждение удаления

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.

Ключевые детали

1. Удаление идентификатора EdgeWorker возможно только в том случае, если в данный момент у него нет активной или активируемой версии в сети Akamai.

2. Перед удалением убедитесь, что с EdgeWorker не связаны никакие активные свойства.

Получение списка версий EdgeWorker

Получение списка информации о версии для данного идентификатора EdgeWorker.

Использование: akamai edgeworkers list-versions [options] [version-identifier]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор версии	необязательный	Уникальный целочисленный дескриптор версии экземпляра EdgeWorkers.

Ключевые детали

1. Набор результатов сортируется по значению последовательности загрузки, которое не отображается (внутреннее увеличенное целое число).

2. Версии EdgeWorker — это строки, определяемые пользователем.

Загрузить новую версию EdgeWorker

Создает новую версию заданного идентификатора EdgeWorker, которая включает пакет кода.

Использование: akamai edgeworkers upload [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--bundle	Путь к файлу пакета в формате tgz
--codeDir	Рабочий каталог, содержащий файлы main.js и Bundle.json.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.

Ключевые детали

1. Должен быть указан один из --bundle или --codeDir (но не оба одновременно).

2. Пути и файлы пакетов кода должны находиться в локальной файловой системе.

3. --bundle ожидает, что файл tgz уже создан в соответствии со спецификацией EdgeWorkers.

4. --codeDir ожидает путь к каталогу, который содержит как main.js (файл событий), так и Bundle.json (файл манифеста).

5. Опция --codeDir обеспечит проверку формата Bundle.json.

6. --codeDir не упаковывает другие каталоги или код, кроме main.js и Bundle.json.

7. --codeDir создаст файл tarball (tgz), если проверка файла завершится успешно.

8. Сервис сравнит контрольную сумму нового архива с ранее загруженными архивами для того же идентификатора EdgeWorker ( ewId ). Если совпадение найдено, создание новой версии запрещено.

9. versionId генерируется пользователем и извлекается из Bundle.json.

10. В заголовке ответа о местоположении будет указан новый идентификатор версии EdgeWorker.

11. В тексте ответа с подробностями версии EdgeWorker (JSON) будет указан код ответа 201.

Удалить существующую версию EdgeWorker

Безвозвратно удалить существующую версию данного идентификатора EdgeWorker.

Использование: akamai edgeworkers delete-version [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--noPrompt	Пропустить запрос на подтверждение удаления

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор версии	необходимый	Уникальный целочисленный дескриптор версии экземпляра EdgeWorkers.

Ключевые детали

1. Удаление версии возможно только в том случае, если она в данный момент не активна или не активируется в сети Akamai.

2. Если версия в настоящее время активна, ее необходимо деактивировать, прежде чем ее можно будет удалить.

Загрузите пакет кода EdgeWorkers

Загрузите пакет кода версии EdgeWorker.

Использование: akamai edgeworkers download [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--downloadPath	Путь для хранения загруженного файла пакета; по умолчанию используется домашний каталог CLI, если он не указан.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор версии	необходимый	Уникальный целочисленный дескриптор версии экземпляра EdgeWorkers.

Ключевые детали

1. Если --downloadPath не указан или не найден в локальной файловой системе, будет использоваться подкаталог кэша AkamaiCLI: /edgeworkers-cli/edgeworkers//

Загрузите комбинированный пакет кода EdgeWorkers

Загрузите объединенный пакет кода, содержащий код и зависимости, которые выполняет EdgeWorker.

Использование: akamai edgeworkers download-revision [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--downloadPath	Путь для хранения загруженного файла объединенного пакета; по умолчанию используется домашний каталог CLI, если он не указан.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Уникальный идентификатор редакции для конкретного экземпляра EdgeWorkers.

Ключевые детали

1. Если --downloadPath не указан или не найден в локальной файловой системе, будет использоваться подкаталог кэша AkamaiCLI: /edgeworkers-cli/edgeworkers//

Получение списка состояний активации версии EdgeWorker

Получение списка статуса активации для данного идентификатора EdgeWorker.

Использование: akamai edgeworkers status [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--versionId	Идентификатор версии
--activationId	Идентификатор активации
--activeOnNetwork	Ограничивает результаты, чтобы отображались только активированные в данный момент версии.
--network	Ограничивает результаты версиями, которые были активированы в определенной сети (СТАДИЙНАЯ или ПРОИЗВОДСТВЕННАЯ).

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.

Ключевые детали

1. Вы не можете предоставить одновременно идентификаторы версии и активации.

Получение списка истории изменений EdgeWorker

Перечислите историю изменений для данного идентификатора EdgeWorker.

Использование: akamai edgeworkers list-revisions [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--versionId	Идентификатор версии
--activationId	Идентификатор активации
--pinnedOnly	Ограничивает результаты, показывая только текущие или ранее закрепленные версии.
--currentlyPinned	Ограничивает результаты, чтобы отображались только те версии, которые в данный момент закреплены.
--network	Ограничивает результаты версиями, которые были активированы в определенной сети (СТАДИЙНАЯ или ПРОИЗВОДСТВЕННАЯ).

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.

Ключевые детали

1. Сеть должна быть либо ПРОИЗВОДСТВЕННОЙ, либо ПРОИЗВОДСТВЕННОЙ. Заглавные буквы будут переведены в верхний регистр.

Получить сведения о версии EdgeWorker

Получите подробную информацию о конкретной версии.

Использование: akamai edgeworkers get-revision [options]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Идентификатор версии

Сравните две детали ревизии EdgeWorker.

Просмотр различий в зависимостях между двумя версиями одного и того же EdgeWorker.

Использование: akamai edgeworkers compare-revisions [options]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Идентификатор первой ревизии
идентификатор ревизии	необходимый	Идентификатор второй ревизии

Ключевые детали

1. Оба идентификатора версии должны быть разными.

Активировать версию EdgeWorker

Активируйте версию для данного идентификатора EdgeWorker в сети Akamai.

Использование: akamai edgeworkers activate-revision [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--примечание	Примечание, указывающее, почему редакция повторно активируется.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Идентификатор версии

Ключевые детали

1. Версия будет повторно активирована в той же сети (ПРОИЗВОДСТВО или ПОСТАВКА), в которой она была активна ранее.

Версия вывода EdgeWorker

Закрепите активную редакцию для данного идентификатора EdgeWorker.

Использование: akamai edgeworkers pin-revision [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--примечание	Примечание для указания причины закрепления версии.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Идентификатор версии

Ключевые детали

1. Перед закреплением редакция должна быть активирована.

Открепить версию EdgeWorker

Открепите активную закрепленную редакцию для данного идентификатора EdgeWorker.

Использование: akamai edgeworkers unpin-revision [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--примечание	Примечание, указывающее, почему редакция открепляется.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Идентификатор версии

Ключевые детали

1. Перед откреплением редакцию необходимо закрепить.

Получить сведения о версии EdgeWorker

Просмотр сведений о конкретной версии составного пакета.

Использование: akamai edgeworkers get-revision-bom [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--activeVersions	Ограничьте результаты, чтобы отображались только активные версии
--currentlyPinnedRevisions	Показывает дополнительную информацию о закрепленной в данный момент версии.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
идентификатор ревизии	необходимый	Идентификатор версии

Список активаций ревизий EdgeWorker

Получение списка статуса активации версии для данного идентификатора EdgeWorker.

Использование: akamai edgeworkers list-revision-activations [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--versionId	Идентификатор версии
--ActivationId	Идентификатор активации
--сеть	Ограничивает результаты версиями, которые были активированы в определенной сети (СТАДИЙНАЯ или ПРОИЗВОДСТВЕННАЯ).

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.

Ключевые детали

1. Вы не можете предоставить одновременно идентификаторы версии и активации.

2. Сеть должна быть либо ПРОИЗВОДСТВЕННОЙ, либо ПРОИЗВОДСТВЕННОЙ. Заглавные буквы будут переведены в верхний регистр.

Активируйте EdgeWorker

Активируйте версию для данного идентификатора EdgeWorker в сети Akamai.

Использование: akamai edgeworkers activate [options]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
сеть	необходимый	Метка, для которой активация сети Akamai (STAGING или PRODUCTION) должна быть отправлена ​​на адрес
идентификатор версии	необходимый	Уникальный целочисленный дескриптор версии экземпляра EdgeWorkers.

Ключевые детали

1. Сеть должна быть либо ПРОИЗВОДСТВЕННОЙ, либо ПРОИЗВОДСТВЕННОЙ. Заглавные буквы будут переведены в верхний регистр.

2. В заголовке ответа о местоположении будет указан новый идентификатор активации EdgeWorker.

3. В тексте ответа с подробностями активации EdgeWorker (JSON) будет указан код ответа 201.

Проверка пакета кода EdgeWorkers

Проверяет версию пакета кода без загрузки пакета кода.

Использование: akamai edgeworkers validate [options]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
Путь пакета	необходимый	Путь к файлу пакета в формате tgz

Ключевые детали

1. Путь к пакету кода должен быть найден в локальной файловой системе.

2. Пакет кода ожидает, что файл tgz уже создан в соответствии со спецификацией EdgeWorkers.

Деактивировать EdgeWorker

Деактивируйте версию для данного идентификатора EdgeWorker в сети Akamai.

Использование: akamai edgeworkers deactivate [options]

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Уникальный целочисленный дескриптор экземпляра EdgeWorkers.
сеть	необходимый	Метка, для которой активация сети Akamai (STAGING или PRODUCTION) должна быть отправлена ​​на адрес
идентификатор версии	необходимый	Уникальный целочисленный дескриптор версии экземпляра EdgeWorkers.

Ключевые детали

1. Сеть должна быть либо ПРОИЗВОДСТВЕННОЙ, либо ПРОИЗВОДСТВЕННОЙ. Заглавные буквы будут переведены в верхний регистр.

2. В заголовке ответа о местоположении будет указан новый идентификатор активации EdgeWorker.

3. В тексте ответа с подробностями активации EdgeWorker (JSON) будет указан код ответа 201.

Создайте токен аутентификации EdgeWorkers

Создает токен аутентификации, который можно использовать для получения подробных заголовков ответов отладки EdgeWorker. Для запуска этой команды вам потребуется интерфейс командной строки EdgeWorkers не ниже 1.7.1. Используйте параметр -V, --version для отображения текущего номера версии CLI EdgeWorkers.

Использование: akamai edgeworkers create-auth-token [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--expiry	Срок действия токена, в минутах.
--format	Формат, в котором будут распечатаны выходные данные

Аргумент	Существование	Описание
имя хоста	опционально	Имя хоста свойства. Если имя хоста не указано, токен создается для всех хостов ( /* ) в рамках свойства. Например: www.test.com, www.test1.com.

Ключевые детали

1. Значение --expiry должно находиться в диапазоне от 1 до 720 минут (12 часов). По умолчанию — 8 hours .

Клонировать идентификатор EdgeWorker

Позволяет клиенту клонировать EdgeWorker из существующего идентификатора EdgeWorker.

Использование: akamai edgeworkers clone [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--ewName	Имя EdgeWorker
--groupId	Идентификатор группы

Аргумент	Существование	Описание
идентификатор ресурсаTierId	необходимый	Идентификатор уровня ресурса, в который будет клонирован EdgeWorker.

Ключевые детали

1. Эта конечная точка позволяет пользователю выбрать другой идентификатор уровня ресурсов для определенного идентификатора EdgeWorker путем его клонирования. Клонирование на тот же уровень ресурсов не удастся.

Получение списка контрактов

Список идентификаторов контрактов, к которым у пользователя есть доступ.

Использование: akamai list-contracts

Вариант	Описание
-х, --help	вывод информации об использовании

Список свойств

Список свойств, связанных с определенным идентификатором EdgeWorker.

Использование: akamai edgeworkers list-properties [options]

Вариант	Описание
-х, --help	вывод информации об использовании
--activeOnly	Возвращает только активные свойства

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Идентификатор EdgeWorker.

Ключевые детали

1. Обратите внимание, что возвращаемое логическое значение LimitedAccessToProperties имеет значение true, если у пользователя нет доступа к группе верхнего уровня в рамках учетной записи или если у него нет роли администратора для этой группы.

Список ограничений

Перечислите различные ограничения EdgeWorkers на количество активаций, идентификаторы EdgeWorkers и версии, которые вы можете развернуть.

Использование: akamai edgeworkers list-limits [options]

Вариант	Описание
-х, --help	вывод информации об использовании

Получение списка уровней ресурсов для определенного идентификатора контракта

Перечислите уровни ресурсов, которые можно использовать для создания или клонирования идентификаторов EdgeWorker.

Использование: akamai list-restiers

Вариант	Описание
--contractId	Уровни ресурсов для указанного идентификатора контракта.
-х, --help	вывод информации об использовании

Ключевые детали

1. Пользователю будет предложено ввести список идентификаторов контрактов, к которым у него есть доступ. Выбранный идентификатор контракта будет использоваться для получения уровня ресурсов.

2. Чтобы отключить подсказку в целях автоматизации, в качестве входных данных можно указать идентификатор контракта.

Получение уровня ресурсов для определенного идентификатора EdgeWorker

Клиенты могут получить сведения об уровне ресурсов для определенного идентификатора EdgeWorker.

Использование: akamai show-restier

Вариант	Описание
-х, --help	вывод информации об использовании

Аргумент	Существование	Описание
EdgeWorkerId	необходимый	Идентификатор EdgeWorker

Получите доступные типы отчетов EdgeWorkers

Перечислите доступные типы отчетов, которые можно создать для идентификатора EdgeWorker.

Использование: akamai get reports

Вариант	Описание
-х, --help	вывод информации об использовании

Ключевые детали

1. Пользователю будет предоставлена ​​таблица с идентификаторами отчетов и описанием каждого отчета. Используйте заданный reportId с командой get report , чтобы получить отчет для данного EdgeWorker.

Получить отчет EdgeWorker

Получите отчет для данного идентификатора EdgeWorker.

Использование: akamai get report

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании
-s, --startDate	необходимый	Временная метка ISO 8601, указывающая время начала отчета EdgeWorkers.
-e, --endDate	необязательный	Временная метка ISO 8601, указывающая время окончания отчета EdgeWorkers. Если не указано, время окончания по умолчанию равно текущему времени.
--status	необязательный	Строка, разделенная запятыми, для фильтрации по статусу EdgeWorkers. Значения: success , genericError , unknownEdgeWorkerId , unimplementedEventHandler , runtimeError , executionError , timeoutError , resourceLimitHit , cpuTimeoutError , wallTimeoutError , initCpuTimeoutError , initWallTimeoutError .
--ev, --eventHandlers	необязательный	Строка, разделенная запятыми, для фильтрации EdgeWorkers по событию, которое их запускает. Значения: onClientRequest , onOriginRequest , onOriginResponse , onClientResponse , responseProvider .

Аргумент	Существование	Описание
идентификатор отчета	необходимый	Тип отчета.
идентификатор EdgeWorker	необходимый	Идентификатор EdgeWorker.

Ключевые детали

1. Чтобы получить список доступных идентификаторов отчетов, используйте команду get reports .

2. Параметр startDate является обязательным.

Перечислите все значения по умолчанию раздела в файле конфигурации

Получите все свойства по умолчанию в разделе файла конфигурации.

Использование: akamai config list

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании

Ключевые детали

1. По умолчанию раздел конфигурации default по умолчанию. Чтобы использовать другой раздел, пользователи должны указать команду akamai edgeworkers с опцией --configSection .

2. Тот же подход должен применяться к следующим командам config .

Получить значение по умолчанию для раздела в файле конфигурации

Получите одно конкретное значение по умолчанию в разделе файла конфигурации.

Использование: akamai config get

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании

Аргумент	Существование	Описание
ключ	необходимый	Имя свойства по умолчанию

Установить/обновить значение по умолчанию для раздела в файле конфигурации

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

Использование: akamai config set

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании

Аргумент	Существование	Описание
ключ	необходимый	Имя свойства по умолчанию
ценить	необходимый	Значение свойства по умолчанию

Удалить значение по умолчанию для раздела в файле конфигурации

Позволяет клиентам отменить определенное значение по умолчанию в разделе файла конфигурации.

Использование: akamai config unset

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании

Аргумент	Существование	Описание
ключ	необходимый	Имя свойства по умолчанию

Массовое сохранение свойства по умолчанию раздела в файле конфигурации

Позволяет клиентам массово сохранять значения по умолчанию.

Использование: akamai config save [options]

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании
-p, --свойства	необходимый	Свойства конфигурации. Используйте формат «ключ=значение», чтобы установить свойство, и пробел для их разделения.

Ключевые детали

1. Если контекст содержит недопустимый элемент, команда пропустит этот элемент и продолжит работу.

Просмотр текущего уровня ведения журнала для EdgeWorker

Позволяет клиентам просматривать подробную информацию о переопределениях уровня ведения журнала для Edgeworker.

Использование: akamai edgeworkers log-level get [options] [logging-identifier]

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании

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

Ключевые детали

1. Если logging-identifier не указан, будут отображены все переопределения уровня ведения журнала.

2. logging-identifier — это числовая константа, определяющая переопределение уровня журнала. Его можно получить во время создания переопределения или путем перечисления всех переопределений без указания необязательного аргумента и поиска поля loggingId конкретного переопределения.

Установите текущий уровень ведения журнала для EdgeWorker

Позволяет клиентам устанавливать уровень ведения журнала для EdgeWorker.

Использование: akamai edgeworkers log-level set [options]

Вариант	Существование	Описание
-х, --help	необязательный	вывод информации об использовании
--истекает	необязательный	Указывает, как долго будет применяться переопределение уровня ведения журнала пользователя. После его прохождения уровень ведения журнала возвращается к значению по умолчанию, указанному в пакете.
--ds2Id	необязательный	Идентификатор потока данных, который будет использоваться вместе с идентификатором, указанным в файле bundle.json EdgeWorker.

Аргумент	Существование	Описание
идентификатор EdgeWorker	необходимый	Идентификатор EdgeWorker, для которого нужно изменить уровень ведения журнала.
сеть	необходимый	Сеть, для которой будет применен новый уровень ведения журнала. Либо «постановка», либо «постановка».
уровень	необходимый	Новый уровень ведения журнала для EdgeWorker. Возможные значения см. в документации по регистрации клиентов.

Ключевые детали

1. Действует только последнее созданное переопределение уровня журнала.

2. По истечении срока действия переопределения уровень ведения журнала сбрасывается на уровень, указанный в файле bundle.json Edgeworker.

3. Если команда выполнена успешно, распечатываются сведения о переопределении уровня журнала, включая loggingId переопределения. loggingId можно использовать для получения этих сведений в любое время, используя подкоманду log-level get и передавая ее в необязательный аргумент logging-identifier .

4. Если опция --expires не указана, по умолчанию срок действия переопределения не истекает.

5. Опция --expires поддерживает как ввод на естественном языке, так и стандартные временные метки. Полную спецификацию можно найти в документации пакета chrono .

Примеры

1. Установите переопределение уровня журнала в производственной сети на информационный уровень, срок действия которого истечет через 1 час.

./akamai-edgeworkers log-level set 654321 production info --expires 1h

2. Установите переопределение уровня журнала в промежуточной сети на уровень трассировки, срок действия которого истечет в 15:00 по центральноевропейскому летнему времени (CEST) 13 августа 2024 года.

./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"

Ресурсы

Для получения дополнительной информации о EdgeWorkers обратитесь к следующим ресурсам:

• Страница разработчика EdgeWorkers

• Руководство пользователя EdgeWorkers

• Руководство по API EdgeWorkers

Отчеты о проблемах

Все готово, удачного кодирования! Если у вас возникли какие-либо проблемы с интерфейсом командной строки EdgeWorkers, сообщите о них как о проблеме на GitHub. Не стесняйтесь создавать запрос на включение с исправлением или предложением.

Содействие

Мы приветствуем вклад сотрудников Akamai, клиентов и других лиц. Прежде чем открыть PR, пожалуйста, дважды проверьте следующее:

1. Пожалуйста, добавьте несколько тестовых примеров в дополнение к вашему пиару. Это проверяет функциональность, добавленную или измененную в PR, и доказывает другим, что ваш код работает :)

2. Убедитесь, что ваш код проходит все проверки перед фиксацией. Ваш код должен быть успешно построен, пройти все модульные тесты и не иметь проблем с линтингом.

3. Все PR должны быть направлены на развитие, а не на освоение. Слияния с мастером будут немедленно доступны всем клиентам.