EdgeWorkers CLI Die EdgeWorkers-Befehlszeilenschnittstelle (CLI) beschleunigt den Prozess des Registrierens, Hochladens, Aktivierens und Testens von EdgeWorkers-Funktionen im Akamai Edge-Netzwerk.
Informationen zum Verwalten von EdgeKV-Datenbanken und zum Aufrufen der EdgeKV-API über die Befehlszeile finden Sie in der Akamai-CLI für EdgeKV.
Um dieses Tool nutzen zu können, benötigen Sie:
brew install akamai Verwendung:
akamai install edgeworkers
Verwendung:
akamai update edgeworkers
Mit der EdgeWorkers-CLI können Sie Standardwerte für die Befehlsoptionen festlegen. Es gibt zwei Möglichkeiten, eine Konfigurationsdatei zu erstellen:
~/.akamai-cli/ew-config und speichern Sie die Eigenschaften wie folgt: [default]
edgeworkerName=testEW
groupId=12345
versionId=1-0-2config , um Standardeigenschaften festzulegen: akamai edgeworkers config set Hier werden verfügbare Eigenschaftsnamen angezeigt.
Mit der EdgeWorkers-CLI können Sie EdgeWorkers-Funktionen durch Aufrufen der EdgeWorkers-API verwalten.
Konventionen:
[]<> Verwendung:
akamai edgeworkers [options] [command]
Optionen:
| Syntax | Beschreibung |
|---|---|
| -V, --version | Zeigen Sie die Versionsnummer für das EdgeWorkers CLI-Programm an. |
| --debuggen | Debug-Informationen anzeigen. |
--edgerc | Verwenden Sie die Anmeldeinformationen in edgerc Datei für den Befehl. (Der Standardspeicherort der Datei ist ~/.edgerc ) |
--section | Verwenden Sie diesen Abschnitt in der edgerc Datei. (Der Standardabschnitt ist [default] ) |
--configSection | Verwenden Sie diesen Abschnitt in der ew-config Datei, die den Standardkonfigurationseigenschaftensatz enthält. (Der Standardabschnitt ist [default] ) |
--timeout | Sie können einen Timeout-Wert für einen Befehl in Sekunden angeben, um den Standardwert von 2 Minuten zu überschreiben. Wenn Sie beispielsweise „--timeout 10“ zu einem Befehl hinzufügen, kommt es zu einer Zeitüberschreitung, wenn der Server mehr als 10 Sekunden für die Antwort benötigt. |
--json [path] | Schreiben Sie die CLI-Ausgabe als JSON in den optional angegebenen Pfad. Wenn kein Pfad angegeben ist, schreiben Sie die JSON-Ausgabe in das CLI-Home-Verzeichnis |
| --jsonout | Schreiben Sie die CLI-Ausgabe als JSON in stdout. |
| -h, --help | Nutzungsinformationen für die EdgeWorkers-CLI anzeigen. |
Befehle:
| Befehl | Alias | Beschreibung |
|---|---|
Hilfe [command] | Zeigt Nutzungsinformationen für den angegebenen Befehl an. |
Listengruppen | lg [group-identifier] | Kundenentwickler können ihre EdgeWorkers-Zugriffsebene pro Luna-Zugriffskontrollgruppe finden. |
Listen-IDs | li [options] [edgeworker-identifier] | Listet die aktuell registrierten EdgeWorker-IDs auf. |
registrieren | create-id | Registrieren Sie eine neue EdgeWorker-ID, um im Verhalten des Property Managers darauf zu verweisen. |
Update-ID | ui | Ermöglicht dem Kundenentwickler, die Luna-ACG- oder Namensattribute eines vorhandenen EdgeWorker-Bezeichners zu aktualisieren. |
Lösch-ID | delete-id [options] | Löschen Sie eine vorhandene EdgeWorker-ID dauerhaft. |
Listenversionen | lv | Versionsinformationen einer bestimmten EdgeWorker-ID auflisten. |
hochladen | create-version [options] | Erstellt eine neue Version einer bestimmten EdgeWorker-ID, die das Codepaket enthält. |
delete-version | delete-version [options] | Löschen Sie eine vorhandene Version einer bestimmten EdgeWorker-ID dauerhaft. |
herunterladen | Download-Version [options] | Laden Sie das Codepaket einer EdgeWorker-Version herunter. |
Download-Revision | dr [options] | Laden Sie das kombinierte Codepaket herunter, das den Code und die Abhängigkeiten enthält, die der EdgeWorker ausführt. |
Status | list-activations [options] | Listen Sie den Aktivierungsstatus einer bestimmten EdgeWorker-ID auf. |
Listenrevisionen | lr [options] | Listen Sie den Revisionsverlauf für eine bestimmte EdgeWorker-ID auf. |
get-revision | gr | Rufen Sie Details zu einer bestimmten Revision ab. |
Vergleichsrevisionen | cr | Zeigen Sie Abhängigkeitsunterschiede zwischen zwei Revisionen desselben EdgeWorker an. |
Aktivierungsrevision | ar [options] | Aktivieren Sie eine Revision für eine bestimmte EdgeWorker-ID im Akamai-Netzwerk. |
pin-revision [options] | Anheften einer aktiven Revision für eine bestimmte EdgeWorker-ID. |
unpin-revision [options] | Lösen Sie eine aktive angeheftete Revision für eine bestimmte EdgeWorker-ID. |
get-revision-bom | gb [options] | Zeigen Sie Details für eine bestimmte Revision eines Verbundpakets an. |
Listenrevisionsaktivierungen | lra [options] | Revisionsaktivierungsstatus einer bestimmten EdgeWorker-ID auflisten. |
aktivieren | av | Aktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk. |
deaktivieren | deact | Deaktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk. |
validieren | vv | Validiert eine Code-Bundle-Version, ohne das Code-Bundle hochzuladen. |
Authentifizierungstoken erstellen | auth [options] | Erzeugt ein Authentifizierungstoken, das zum Abrufen detaillierter EdgeWorker-Debug-Antwortheader verwendet werden kann. Sie benötigen mindestens Version 1.7.1 der EdgeWorkers CLI, um diesen Befehl auszuführen. |
Klon | clone | Klont einen EdgeWorker aus der vorhandenen EdgeWorker-ID. |
Listenverträge | Li-Verträge [options] | Liste der Vertrags-IDs, auf die der Benutzer Zugriff hat. |
Listeneigenschaften | lp | Liste der Eigenschaften, die einer bestimmten EdgeWorker-ID zugeordnet sind. |
| Listenlimits | li-limits | Sehen Sie sich die verschiedenen Beschränkungen an, die EdgeWorkers für die Anzahl der Aktivierungen, EdgeWorkers-IDs und Versionen festlegt, die Sie bereitstellen können. |
list-restiers | li-restiers [options] | Listen Sie Ressourcenebenen auf, die zum Erstellen oder Klonen von EdgeWorker-IDs verwendet werden können. |
show-restier | show-restier | Kunden können Details zur Ressourcenstufe für eine bestimmte EdgeWorker-ID erhalten. |
| Berichte einholen | Erhalten Sie eine Liste aller verfügbaren EdgeWorkers-Berichte. |
get report | Rufen Sie einen EdgeWorkers-Bericht für eine bestimmte EdgeWorker-ID ab. |
| Konfigurationsliste | Rufen Sie alle Werte in der Konfigurationsdatei ab. |
config get | Rufen Sie einen Konfigurationswert aus einem Abschnitt in der Konfigurationsdatei ab. |
config set | Legen Sie einen Konfigurationswert in einem Abschnitt fest. |
config save -p | Konfigurationseigenschaften in einem Abschnitt speichern. |
config unset | Setzen Sie einen Konfigurationswert in einem Abschnitt zurück. |
Kundenentwickler können ihre EdgeWorkers-Zugriffsebene pro Luna-Zugriffskontrollgruppe finden.
Verwendung: akamai edgeworkers list-groups [options] [group-identifier]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Gruppenidentifikator | optional | Wert der Luna-Zugriffsgruppe (normalerweise eine Zahl), um nach EdgeWorkers-Berechtigungen zu suchen |
Die Ausgabe wird nur auf die Luna-Zugriffskontrollgruppen gefiltert, die über mindestens eine EdgeWorkers-Fähigkeit verfügen.
Folgende Funktionen können verfügbar sein: VIEW,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE
Listet die aktuell registrierten EdgeWorker-IDs auf.
Verwendung: akamai edgeworkers list-ids [options] [edgeworker-identifier]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--groupId | Filtern Sie die EdgeWorker-ID-Liste nach Berechtigungsgruppe |
--resourceTierId | Filtern Sie die EdgeWorker-ID nach Ressourcenebene |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | optional | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
Registrieren Sie eine neue EdgeWorker-ID, um im Verhalten des Property Managers darauf zu verweisen.
Verwendung: akamai edgeworkers register [options]
| Option | Beschreibung |
|---|---|
| --resourceTierId | Neue Ressourcenebenen-ID, der der EdgeWorker zugeordnet wird. |
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Gruppenidentifikator | erforderlich | Wert der Luna-Zugriffsgruppe (normalerweise eine Zahl), um nach EdgeWorkers-Berechtigungen zu suchen |
| Edgeworker-Name | erforderlich | Für Menschen lesbares Kurzetikett, das eine EdgeWorkers-Instanz beschreibt |
Der Standortantwortheader wird mit der neuen EdgeWorker-ID bereitgestellt.
Der Antworttext (JSON) für die EdgeWorker-ID-Details wird mit dem Antwortcode 201 bereitgestellt.
Um Eingabeaufforderungen für Automatisierungszwecke zu deaktivieren, kann „resourceTierId“ als Eingabe bereitgestellt werden.
Ermöglicht dem Kundenentwickler, die Luna-ACG- oder Namensattribute eines vorhandenen EdgeWorker-Bezeichners zu aktualisieren.
Verwendung: akamai edgeworkers update-id [options]
| Option | Beschreibung |
|---|---|
| --resourceTierId | Neue Ressourcenebenen-ID, der der EdgeWorker zugeordnet wird |
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Gruppenidentifikator | erforderlich | Wert der Luna-Zugriffsgruppe (normalerweise eine Zahl), um nach EdgeWorkers-Berechtigungen zu suchen |
| Edgeworker-Name | erforderlich | Für Menschen lesbares Kurzetikett, das eine EdgeWorkers-Instanz beschreibt |
Die API erfordert, dass sowohl Gruppen-ID als auch Name angegeben werden, auch wenn nur eines dieser Attribute geändert wird.
Der Antworttext (JSON) für die EdgeWorker-ID-Details wird mit dem Antwortcode 200 bereitgestellt.
Die bereitgestellte Ressourcenebenen-ID sollte mit der identisch sein, die die EdgeWorker-ID bereits hat. Um eine andere Ressourcenebenen-ID bereitzustellen, verwenden Sie bitte den Klonvorgang.
Löschen Sie einen vorhandenen EdgeWorker-Bezeichner dauerhaft.
Verwendung: akamai edgeworkers delete-id [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --noPrompt | Überspringen Sie die Löschbestätigungsaufforderung |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
Das Löschen einer EdgeWorker-ID ist nur möglich, wenn für sie derzeit keine Version aktiv ist oder im Akamai-Netzwerk aktiviert wird.
Stellen Sie vor dem Löschen sicher, dass einem EdgeWorker keine aktiven Eigenschaften zugeordnet sind.
Versionsinformationen einer bestimmten EdgeWorker-ID auflisten.
Verwendung: akamai edgeworkers list-versions [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Versionskennung | optional | Ein eindeutiges ganzzahliges Handle für die Version einer EdgeWorkers-Instanz |
Der Ergebnissatz wird nach einem Upload-Sequenzwert sortiert, der nicht angezeigt wird (eine intern inkrementierte Ganzzahl).
EdgeWorker-Versionen sind vom Kunden definierte Zeichenfolgen.
Erstellt eine neue Version einer bestimmten EdgeWorker-ID, die das Codepaket enthält.
Verwendung: akamai edgeworkers upload [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--bundle | Pfad zur Bundle-Datei im TGZ-Format |
--codeDir | Arbeitsverzeichnis, das die Dateien main.js und bundle.json enthält |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
Es muss entweder --bundle oder --codeDir (jedoch nicht beides) angegeben werden.
Code-Bundle-Pfade und -Dateien müssen im lokalen Dateisystem gefunden werden.
--bundle erwartet eine tgz-Datei, die bereits gemäß der EdgeWorkers-Spezifikation erstellt wurde.
--codeDir erwartet einen Verzeichnispfad, der sowohl main.js (Ereignisdatei) als auch bundle.json (Manifestdatei) enthält.
Die Option --codeDir ermöglicht die Validierung des bundle.json-Formats.
--codeDir packt keine anderen Verzeichnisse oder Codes außer main.js und bundle.json.
--codeDir erstellt die Tarball-Datei (tgz), wenn die Dateivalidierung erfolgreich ist.
Der Dienst vergleicht die Prüfsumme des neuen Tarballs mit zuvor hochgeladenen Tarballs für dieselbe EdgeWorker-ID ( ewId ). Wenn eine Übereinstimmung gefunden wird, ist die Erstellung einer neuen Version nicht zulässig.
versionId wird vom Kunden generiert und aus bundle.json abgerufen.
Der Standortantwortheader wird mit der neuen EdgeWorker-Versions-ID bereitgestellt.
Der Antworttext (JSON) für die EdgeWorker-Versionsdetails wird mit dem Antwortcode 201 bereitgestellt.
Löschen Sie eine vorhandene Version einer bestimmten EdgeWorker-ID dauerhaft.
Verwendung: akamai edgeworkers delete-version [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --noPrompt | Überspringen Sie die Löschbestätigungsaufforderung |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Versionskennung | erforderlich | Ein eindeutiges ganzzahliges Handle für die Version einer EdgeWorkers-Instanz |
Das Löschen einer Version ist nur möglich, wenn sie derzeit nicht aktiv ist oder im Akamai-Netzwerk aktiviert wird.
Wenn die Version derzeit aktiv ist, muss sie deaktiviert werden, bevor sie gelöscht werden kann.
Laden Sie das Codepaket einer EdgeWorker-Version herunter.
Verwendung: akamai edgeworkers download [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--downloadPath | Pfad zum Speichern der heruntergeladenen Bundle-Datei; Wenn nicht angegeben, wird standardmäßig das CLI-Home-Verzeichnis verwendet. |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Versionskennung | erforderlich | Ein eindeutiges ganzzahliges Handle für die Version einer EdgeWorkers-Instanz |
--downloadPath nicht bereitgestellt wird oder nicht im lokalen Dateisystem gefunden wird, wird ein AkamaiCLI-Cache-Unterverzeichnis verwendet: /edgeworkers-cli/edgeworkers// Laden Sie das kombinierte Codepaket herunter, das den Code und die Abhängigkeiten enthält, die der EdgeWorker ausführt.
Verwendung: akamai edgeworkers download-revision [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--downloadPath | Pfad zum Speichern der heruntergeladenen kombinierten Bundle-Datei; Wenn nicht angegeben, wird standardmäßig das CLI-Home-Verzeichnis verwendet. |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Eine eindeutige Revisionskennung für eine bestimmte EdgeWorkers-Instanz |
--downloadPath nicht bereitgestellt wird oder nicht im lokalen Dateisystem gefunden wird, wird ein AkamaiCLI-Cache-Unterverzeichnis verwendet: /edgeworkers-cli/edgeworkers// Listen Sie den Aktivierungsstatus einer bestimmten EdgeWorker-ID auf.
Verwendung: akamai edgeworkers status [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--versionId | Versionskennung |
--activationId | Aktivierungskennung |
| --activeOnNetwork | Beschränkt die Ergebnisse auf die Anzeige nur aktuell aktivierter Versionen |
--network | Beschränkt die Ergebnisse auf Versionen, die in einem bestimmten Netzwerk aktiviert wurden (STAGING oder PRODUCTION) |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
Listen Sie den Revisionsverlauf für eine bestimmte EdgeWorker-ID auf.
Verwendung: akamai edgeworkers list-revisions [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--versionId | Versionskennung |
--activationId | Aktivierungskennung |
| --pinnedOnly | Beschränkt die Ergebnisse so, dass nur aktuell oder zuvor angeheftete Revisionen angezeigt werden |
| --currentlyPinned | Beschränkt die Ergebnisse so, dass nur aktuell angeheftete Revisionen angezeigt werden |
--network | Beschränkt die Ergebnisse auf Versionen, die in einem bestimmten Netzwerk aktiviert wurden (STAGING oder PRODUCTION) |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
Rufen Sie Details zu einer bestimmten Revision ab.
Verwendung: akamai edgeworkers get-revision [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Revisionskennung |
Zeigen Sie Abhängigkeitsunterschiede zwischen zwei Revisionen desselben EdgeWorker an.
Verwendung: akamai edgeworkers compare-revisions [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Erste Revisionskennung |
| Revisionsidentifikator | erforderlich | Zweite Revisionskennung |
Aktivieren Sie eine Revision für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.
Verwendung: akamai edgeworkers activate-revision [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --Notiz | Hinweis zur Angabe, warum die Revision reaktiviert wird |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Revisionskennung |
Anheften einer aktiven Revision für eine bestimmte EdgeWorker-ID.
Verwendung: akamai edgeworkers pin-revision [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --Notiz | Hinweis, um anzugeben, warum die Revision angeheftet wird |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Revisionskennung |
Lösen Sie eine aktive angeheftete Revision für eine bestimmte EdgeWorker-ID.
Verwendung: akamai edgeworkers unpin-revision [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --Notiz | Hinweis, um anzugeben, warum die Revision nicht angeheftet wird |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Revisionskennung |
Zeigen Sie Details für eine bestimmte Revision eines Verbundpakets an.
Verwendung: akamai edgeworkers get-revision-bom [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --activeVersions | Beschränken Sie die Ergebnisse, um nur aktive Versionen anzuzeigen |
| --currentlyPinnedRevisions | Zeigt zusätzliche Informationen zur aktuell angehefteten Revision an |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Revisionsidentifikator | erforderlich | Revisionskennung |
Revisionsaktivierungsstatus einer bestimmten EdgeWorker-ID auflisten.
Verwendung: akamai edgeworkers list-revision-activations [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --versionId | Versionskennung |
| --activationId | Aktivierungs-ID |
| --Netzwerk | Beschränkt die Ergebnisse auf Versionen, die in einem bestimmten Netzwerk aktiviert wurden (STAGING oder PRODUCTION) |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
Aktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.
Verwendung: akamai edgeworkers activate [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Netzwerk | erforderlich | Bezeichnung, an die die Aktivierung des Akamai-Netzwerks (STAGING oder PRODUCTION) gesendet werden soll |
| Versionskennung | erforderlich | Ein eindeutiges ganzzahliges Handle für die Version einer EdgeWorkers-Instanz |
Das Netzwerk muss entweder STAGING oder PRODUCTION sein. Die Großschreibung wird auf Großbuchstaben normalisiert.
Der Standortantwortheader wird mit der neuen EdgeWorker-Aktivierungs-ID bereitgestellt.
Der Antworttext (JSON) für die EdgeWorker-Aktivierungsdetails wird mit dem Antwortcode 201 bereitgestellt.
Validiert eine Code-Bundle-Version, ohne das Code-Bundle hochzuladen
Verwendung: akamai edgeworkers validate [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| bundlePath | erforderlich | Pfad zur Bundle-Datei im TGZ-Format |
Der Code-Bundle-Pfad muss im lokalen Dateisystem gefunden werden.
Das Codepaket erwartet eine bereits gemäß der EdgeWorkers-Spezifikation erstellte TGZ-Datei.
Deaktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.
Verwendung: akamai edgeworkers deactivate [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz |
| Netzwerk | erforderlich | Bezeichnung, an die die Aktivierung des Akamai-Netzwerks (STAGING oder PRODUCTION) gesendet werden soll |
| Versionskennung | erforderlich | Ein eindeutiges ganzzahliges Handle für die Version einer EdgeWorkers-Instanz |
Das Netzwerk muss entweder STAGING oder PRODUCTION sein. Die Großschreibung wird auf Großbuchstaben normalisiert.
Der Standortantwortheader wird mit der neuen EdgeWorker-Aktivierungs-ID bereitgestellt.
Der Antworttext (JSON) für die EdgeWorker-Aktivierungsdetails wird mit dem Antwortcode 201 bereitgestellt.
Erzeugt ein Authentifizierungstoken, das zum Abrufen detaillierter EdgeWorker-Debug-Antwortheader verwendet werden kann. Sie benötigen mindestens Version 1.7.1 der EdgeWorkers CLI, um diesen Befehl auszuführen. Verwenden Sie die Option -V, --version, um die aktuelle Versionsnummer der EdgeWorkers-CLI anzuzeigen.
Verwendung: akamai edgeworkers create-auth-token [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
--expiry | Ablaufdauer des Tokens in Minuten. |
--format | Format, in dem die Ausgabe gedruckt wird |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Hostname | optional | HostName der Eigenschaft. Wenn kein Hostname angegeben wird, wird unter der Eigenschaft ein Token für alle Hosts ( /* ) erstellt. Beispiel: www.test.com, www.test1.com |
--expiry muss zwischen 1 und 720 Minuten (12 Stunden) liegen. Der Standardwert beträgt 8 hours .Ermöglicht dem Kunden, einen EdgeWorker von einer vorhandenen EdgeWorker-ID zu klonen.
Verwendung: akamai edgeworkers clone
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --ewName | Name des EdgeWorkers |
| --groupId | Gruppenkennung |
| Argument | Existenz | Beschreibung |
|---|---|---|
| resourcesTierId | erforderlich | Ressourcenebenen-ID, auf die der EdgeWorker geklont wird. |
Liste der Vertrags-IDs, auf die der Benutzer Zugriff hat.
Verwendung: akamai list-contracts
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
Liste der Eigenschaften, die einer bestimmten EdgeWorker-ID zugeordnet sind.
Verwendung: akamai edgeworkers list-properties
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| --activeOnly | Gibt nur aktive Eigenschaften zurück |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | EdgeWorker-ID. |
Listen Sie die verschiedenen Beschränkungen auf, die EdgeWorkers für die Anzahl der Aktivierungen, EdgeWorkers-IDs und Versionen festlegt, die Sie bereitstellen können.
Verwendung: akamai edgeworkers list-limits [options]
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
Listen Sie Ressourcenebenen auf, die zum Erstellen oder Klonen von EdgeWorker-IDs verwendet werden können.
Verwendung: akamai list-restiers
| Option | Beschreibung |
|---|---|
| --contractId | Ressourcenstufen für die angegebene Vertrags-ID. |
| -h, --help | Nutzungsinformationen ausgeben |
Kunden können Details zur Ressourcenstufe für eine bestimmte EdgeWorker-ID erhalten.
Verwendung: akamai show-restier
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| EdgeworkerId | erforderlich | EdgeWorker-ID |
Listen Sie die verfügbaren Berichtstypen auf, die für eine EdgeWorker-ID generiert werden können.
Verwendung: akamai get reports
| Option | Beschreibung |
|---|---|
| -h, --help | Nutzungsinformationen ausgeben |
get report um einen Bericht für einen bestimmten EdgeWorker abzurufen.Rufen Sie einen Bericht für eine bestimmte EdgeWorker-ID ab.
Verwendung: akamai get report
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
-s, --startDate | erforderlich | ISO 8601-Zeitstempel, der die Startzeit des EdgeWorkers-Berichts angibt. |
-e, --endDate | optional | ISO 8601-Zeitstempel, der die Endzeit des EdgeWorkers-Berichts angibt. Wenn nicht angegeben, wird als Endzeit standardmäßig die aktuelle Zeit verwendet. |
--status | optional | Durch Kommas getrennte Zeichenfolge zum Filtern nach EdgeWorkers-Status. Werte: success , genericError , unknownEdgeWorkerId , unimplementedEventHandler , runtimeError , executionError , timeoutError , resourceLimitHit , cpuTimeoutError , wallTimeoutError , initCpuTimeoutError , initWallTimeoutError . |
--ev, --eventHandlers | optional | Durch Kommas getrennte Zeichenfolge zum Filtern von EdgeWorkern nach dem Ereignis, das sie auslöst. Werte: onClientRequest , onOriginRequest , onOriginResponse , onClientResponse , responseProvider . |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Berichts-ID | erforderlich | Berichtstyp. |
| Edgeworker-Identifikator | erforderlich | EdgeWorker-ID. |
get reports .startDate ist eine erforderliche Option.Rufen Sie alle Standardeigenschaften in einem Abschnitt der Konfigurationsdatei ab.
Verwendung: akamai config list
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
default . Um einen anderen Abschnitt zu verwenden, sollten Benutzer den Befehl akamai edgeworkers mit der Option --configSection angeben.config gelten.Rufen Sie einen bestimmten Standardwert in einem Abschnitt der Konfigurationsdatei ab.
Verwendung: akamai config get
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Schlüssel | erforderlich | Name der Standardeigenschaft |
Ermöglicht Kunden das Festlegen/Aktualisieren eines bestimmten Standardwerts in einem Abschnitt der Konfigurationsdatei.
Verwendung: akamai config set
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Schlüssel | erforderlich | Name der Standardeigenschaft |
| Wert | erforderlich | Wert der Standardeigenschaft |
Ermöglicht Kunden, einen bestimmten Standardwert in einem Abschnitt der Konfigurationsdatei aufzuheben.
Verwendung: akamai config unset
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Schlüssel | erforderlich | Name der Standardeigenschaft |
Ermöglicht Kunden, die Standardwerte in großen Mengen zu speichern.
Verwendung: akamai config save [options]
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
| -p, --properties | erforderlich | Eigenschaften konfigurieren. Verwenden Sie das Format „key=value“, um eine Eigenschaft festzulegen, und Leerzeichen, um sie aufzuteilen. |
Ermöglicht Kunden, die Details der Protokollierungsstufenüberschreibungen für den Edgeworker anzuzeigen.
Verwendung: akamai edgeworkers log-level get [options]
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | EdgeWorker-Bezeichner, für den Informationen zur Überschreibung der Protokollierungsstufe angezeigt werden sollen. |
| Protokollierungs-ID | optional | Die Protokollierungs-ID der anzuzeigenden Protokollierungsstufenüberschreibung. |
logging-identifier nicht angegeben ist, werden alle Überschreibungen der Protokollierungsstufe angezeigt.logging-identifier ist eine numerische Konstante, die eine Überschreibung der Protokollebene identifiziert. Sie kann während der Erstellung der Überschreibung abgerufen werden oder indem alle Überschreibungen aufgelistet werden, ohne das optionale Argument anzugeben und das loggingId Feld einer bestimmten Überschreibung nachzuschlagen.Ermöglicht Kunden, die Protokollierungsebene für den EdgeWorker festzulegen.
Verwendung: akamai edgeworkers log-level set [options]
| Option | Existenz | Beschreibung |
|---|---|---|
| -h, --help | optional | Nutzungsinformationen ausgeben |
| --expires | optional | Gibt an, wie lange die Überschreibung der Protokollierungsstufe des Benutzers angewendet wird. Nach Ablauf wird die Protokollierungsstufe wieder auf die im Bundle angegebene Standardeinstellung zurückgesetzt. |
| --ds2Id | optional | Datenstrom-ID, die zusammen mit der in der Datei bundle.json von EdgeWorker angegebenen verwendet werden soll. |
| Argument | Existenz | Beschreibung |
|---|---|---|
| Edgeworker-Identifikator | erforderlich | EdgeWorker-Bezeichner, für den die Protokollierungsebene geändert werden soll. |
| Netzwerk | erforderlich | Netzwerk, für das die neue Protokollierungsstufe angewendet werden soll. Entweder „Produktion“ oder „Inszenierung“. |
| Ebene | erforderlich | Neue Protokollierungsebene für den EdgeWorker. Mögliche Werte finden Sie in der Protokollierungsdokumentation des Kunden. |
bundle.json von Edgeworker angegebene zurückgesetzt.loggingId der Überschreibung. Die loggingId kann verwendet werden, um diese Details jederzeit abzurufen, indem der Unterbefehl log-level get verwendet und an ein optionales Argument logging-identifier übergeben wird.--expires nicht angegeben ist, läuft die Außerkraftsetzung standardmäßig nie ab.--expires unterstützt sowohl die Eingabe in natürlicher Sprache als auch Standardzeitstempel. Die vollständigen Spezifikationen finden Sie in der Dokumentation chrono Pakets. ./akamai-edgeworkers log-level set 654321 production info --expires 1h
./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"
Weitere Informationen zu EdgeWorkers finden Sie in den folgenden Ressourcen:
Sie sind fertig, viel Spaß beim Codieren! Wenn Sie Probleme mit der EdgeWorkers-CLI haben, melden Sie diese als Github-Problem. Sie können gerne eine Pull-Anfrage mit dem Fix oder Vorschlag erstellen.
Wir freuen uns über Beiträge von Akamai-Mitarbeitern, Kunden und anderen. Bevor Sie eine PR eröffnen, überprüfen Sie bitte Folgendes:
