Startseite>Programmierbezogen>Anderer Quellcode
Herunterladen

EdgeWorkers-CLI

EdgeWorkers CLI Die EdgeWorkers-Befehlszeilenschnittstelle (CLI) beschleunigt den Prozess der Registrierung, des Hochladens, der Aktivierung und des 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.

Technische Setup-Anforderungen

Um dieses Tool nutzen zu können, benötigen Sie:

  • Akamai-CLI installiert.

    • Wenn Sie nicht über die CLI verfügen und Homebrew auf einem Mac verwenden, führen Sie diesen Befehl aus: brew install akamai

    • Sie können auch betriebssystemspezifische CLI-Binärdateien oder ein Docker-Image herunterladen

  • Gültige EdgeGrid-Anmeldeinformationen, die über das Akamai Control Center konfiguriert wurden (siehe Erste Schritte mit APIs)

  • Knotenversion 14 oder höher

Installieren oder aktualisieren Sie die EdgeWorker

  • Wenn Sie das EdgeWorkers-CLI-Paket nicht installiert haben, verwenden Sie den folgenden Akamai-CLI-Befehl, um das neueste EdgeWorkers-CLI-Paket zu installieren:

Verwendung:
akamai install edgeworkers

  • Wenn Sie die CLI bereits installiert haben, verwenden Sie den folgenden Akamai-CLI-Befehl, um das neueste EdgeWorkers-CLI-Paket zu installieren, das EdgeKV-Funktionalität enthält:

Verwendung:
akamai update edgeworkers

Geben Sie Standardkonfigurationseigenschaften an

Mit der EdgeWorkers-CLI können Sie Standardwerte für die Befehlsoptionen festlegen. Es gibt zwei Möglichkeiten, eine Konfigurationsdatei zu erstellen:

  1. Erstellen Sie eine Konfigurationsdatei ~/.akamai-cli/ew-config und speichern Sie die Eigenschaften wie folgt:

 [Standard]
EdgeworkerName=testEW
Gruppen-ID=12345
versionId=1-0-2

  1. Verwenden Sie den Befehl config , um Standardeigenschaften festzulegen: akamai edgeworkers config set <key> <value>

Hier werden verfügbare Eigenschaftsnamen angezeigt.

Übersicht über Befehle

Mit der EdgeWorkers-CLI können Sie EdgeWorkers-Funktionen durch Aufrufen der EdgeWorkers-API verwalten.

Konventionen:

  • optionale Argumente []

  • erforderliche Argumente <>

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 <path> Verwenden Sie die Anmeldeinformationen in edgerc Datei für den Befehl. (Der Standardspeicherort der Datei ist ~/.edgerc )
--section <name> Verwenden Sie diesen Abschnitt in der edgerc Datei. (Der Standardabschnitt ist [default] )
--configSection <configSection> Verwenden Sie diesen Abschnitt in der ew-config Datei, die den Standardkonfigurationseigenschaftensatz enthält. (Der Standardabschnitt ist [default] )
--timeout <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 <group-identifier> <edgeworker-name> Registrieren Sie eine neue EdgeWorker-ID, um im Verhalten des Property Managers darauf zu verweisen.
Update-ID | ui <edgeworker-identifier> <group-identifier> <edgeworker-name> [options] Ermöglicht dem Kundenentwickler, die Luna-ACG- oder Namensattribute eines vorhandenen EdgeWorker-Bezeichners zu aktualisieren.
Lösch-ID | delete-id [options] <edgeworker-identifier> Löschen Sie eine vorhandene EdgeWorker-ID dauerhaft.
Listenversionen | lv <edgeworker-identifier> [version-identifier] Versionsinformationen einer bestimmten EdgeWorker-ID auflisten.
hochladen | create-version [options] <edgeworker-identifier> Erstellt eine neue Version einer bestimmten EdgeWorker-ID, die das Codepaket enthält.
delete-version | delete-version [options] <edgeworker-identifier> <version-identifier> Löschen Sie eine vorhandene Version einer bestimmten EdgeWorker-ID dauerhaft.
herunterladen | Download-Version [options] <edgeworker-identifier> <version-identifier> Laden Sie das Codepaket einer EdgeWorker-Version herunter.
Download-Revision | dr [options] <edgeworker-identifier> <revision-identifier> Laden Sie das kombinierte Codepaket herunter, das den Code und die Abhängigkeiten enthält, die der EdgeWorker ausführt.
Status | list-activations [options] <edgeworker-identifier> Listen Sie den Aktivierungsstatus einer bestimmten EdgeWorker-ID auf.
Listenrevisionen | lr [options] <edgeworker-identifier> Listen Sie den Revisionsverlauf für eine bestimmte EdgeWorker-ID auf.
get-revision | gr <edgeworker-identifier> <revision-identifier> Rufen Sie Details zu einer bestimmten Revision ab.
Vergleichsrevisionen | cr <edgeworker-identifier> <revision-identifier> <revision-identifier> Zeigen Sie Abhängigkeitsunterschiede zwischen zwei Revisionen desselben EdgeWorker an.
Aktivierungsrevision | ar [options] <edgeworker-identifier> <revision-identifier> Aktivieren Sie eine Revision für eine bestimmte EdgeWorker-ID im Akamai-Netzwerk.
pin-revision [options] <edgeworker-identifier> <revision-identifier> Anheften einer aktiven Revision für eine bestimmte EdgeWorker-ID.
unpin-revision [options] <edgeworker-identifier> <revision-identifier> Lösen Sie eine aktive angeheftete Revision für eine bestimmte EdgeWorker-ID.
get-revision-bom | gb [options] <edgeworker-identifier> <revision-identifier> Zeigen Sie Details für eine bestimmte Revision eines Verbundpakets an.
Listenrevisionsaktivierungen | lra [options] <edgeworker-identifier> Revisionsaktivierungsstatus einer bestimmten EdgeWorker-ID auflisten.
aktivieren | av <edgeworker-identifier> <network> <versionId> Aktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.
deaktivieren | deact <edgeworker-identifier> <network> <versionId> Deaktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.
validieren | vv <bundlePath> Validiert eine Code-Bundle-Version, ohne das Code-Bundle hochzuladen.
Authentifizierungstoken erstellen | auth [options] <hostName> 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 <edgeworker-identifier> <resourceTierId> [options] 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 <edgeworker-identifier> [options] 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 <edgeworker-identifier> 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 <reportId> <edgeworker-identifier> [options] Rufen Sie einen EdgeWorkers-Bericht für eine bestimmte EdgeWorker-ID ab.
Konfigurationsliste Rufen Sie alle Werte in der Konfigurationsdatei ab.
config get <key> Rufen Sie einen Konfigurationswert aus einem Abschnitt in der Konfigurationsdatei ab.
config set <key> <value> Legen Sie einen Konfigurationswert in einem Abschnitt fest.
config save -p <properties> Konfigurationseigenschaften in einem Abschnitt speichern.
config unset <key> Setzen Sie einen Konfigurationswert in einem Abschnitt zurück.

Listen Sie Berechtigungsgruppen mit EdgeWorkers-Zugriff auf

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

Wichtige Details

  1. Die Ausgabe wird nur auf die Luna-Zugriffskontrollgruppen gefiltert, die über mindestens eine EdgeWorkers-Fähigkeit verfügen.

  2. Folgende Funktionen können verfügbar sein: VIEW,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE

Vorhandene EdgeWorker-Identifikatoren auflisten

Listet die aktuell registrierten EdgeWorker-IDs auf.

Verwendung: akamai edgeworkers list-ids [options] [edgeworker-identifier]

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--groupId <groupId> Filtern Sie die EdgeWorker-ID-Liste nach Berechtigungsgruppe
--resourceTierId <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 die neue EdgeWorker-ID

Registrieren Sie eine neue EdgeWorker-ID, um im Verhalten des Property Managers darauf zu verweisen.

Verwendung: akamai edgeworkers register [options] <group-identifier> <edgeworker-name>

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

Wichtige Details

  1. Der Standortantwortheader wird mit der neuen EdgeWorker-ID bereitgestellt.

  2. Der Antworttext (JSON) für die EdgeWorker-ID-Details wird mit dem Antwortcode 201 bereitgestellt.

  3. Um Eingabeaufforderungen für Automatisierungszwecke zu deaktivieren, kann „resourceTierId“ als Eingabe bereitgestellt werden.

Aktualisieren Sie die Informationen des EdgeWorker-Identifikators

Ermöglicht dem Kundenentwickler, die Luna-ACG- oder Namensattribute eines vorhandenen EdgeWorker-Bezeichners zu aktualisieren.

Verwendung: akamai edgeworkers update-id [options] <edgeworker-identifier> <group-identifier> <edgeworker-name>

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

Wichtige Details

  1. Die API erfordert, dass sowohl Gruppen-ID als auch Name angegeben werden, auch wenn nur eines dieser Attribute geändert wird.

  2. Der Antworttext (JSON) für die EdgeWorker-ID-Details wird mit dem Antwortcode 200 bereitgestellt.

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

Vorhandenen EdgeWorker-Bezeichner löschen

Löschen Sie einen vorhandenen EdgeWorker-Bezeichner dauerhaft.

Verwendung: akamai edgeworkers delete-id [options] <edgeworker-identifier>

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

Wichtige Details

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

  2. Stellen Sie vor dem Löschen sicher, dass einem EdgeWorker keine aktiven Eigenschaften zugeordnet sind.

EdgeWorker-Versionen auflisten

Versionsinformationen einer bestimmten EdgeWorker-ID auflisten.

Verwendung: akamai edgeworkers list-versions [options] <edgeworker-identifier> [version-identifier]

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

Wichtige Details

  1. Der Ergebnissatz wird nach einem Upload-Sequenzwert sortiert, der nicht angezeigt wird (eine intern inkrementierte Ganzzahl).

  2. EdgeWorker-Versionen sind vom Kunden definierte Zeichenfolgen.

Laden Sie eine neue EdgeWorker-Version hoch

Erstellt eine neue Version einer bestimmten EdgeWorker-ID, die das Codepaket enthält.

Verwendung: akamai edgeworkers upload [options] <edgeworker-identifier>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--bundle <bundlePath> Pfad zur Bundle-Datei im TGZ-Format
--codeDir <workingDirectory> 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

Wichtige Details

  1. Es muss entweder --bundle oder --codeDir (jedoch nicht beides) angegeben werden.

  2. Code-Bundle-Pfade und -Dateien müssen im lokalen Dateisystem gefunden werden.

  3. --bundle erwartet eine tgz-Datei, die bereits gemäß der EdgeWorkers-Spezifikation erstellt wurde.

  4. --codeDir erwartet einen Verzeichnispfad, der sowohl main.js (Ereignisdatei) als auch bundle.json (Manifestdatei) enthält.

  5. Die Option --codeDir bietet eine Validierung des bundle.json-Formats.

  6. --codeDir packt keine anderen Verzeichnisse oder Codes außer main.js und bundle.json.

  7. --codeDir erstellt die Tarball-Datei (tgz), wenn die Dateivalidierung erfolgreich ist.

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

  9. versionId wird vom Kunden generiert und aus bundle.json abgerufen.

  10. Der Standortantwortheader wird mit der neuen EdgeWorker-Versions-ID bereitgestellt.

  11. Der Antworttext (JSON) für die EdgeWorker-Versionsdetails wird mit dem Antwortcode 201 bereitgestellt.

Vorhandene EdgeWorker-Version löschen

Löschen Sie eine vorhandene Version einer bestimmten EdgeWorker-ID dauerhaft.

Verwendung: akamai edgeworkers delete-version [options] <edgeworker-identifier> <version-identifier>

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

Wichtige Details

  1. Das Löschen einer Version ist nur möglich, wenn sie derzeit nicht aktiv ist oder im Akamai-Netzwerk aktiviert wird.

  2. Wenn die Version derzeit aktiv ist, muss sie deaktiviert werden, bevor sie gelöscht werden kann.

Laden Sie ein EdgeWorkers-Codepaket herunter

Laden Sie das Codepaket einer EdgeWorker-Version herunter.

Verwendung: akamai edgeworkers download [options] <edgeworker-identifier> <version-identifier>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--downloadPath <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

Wichtige Details

  1. Wenn --downloadPath nicht bereitgestellt wird oder nicht im lokalen Dateisystem gefunden wird, wird ein AkamaiCLI-Cache-Unterverzeichnis verwendet: <CLI_CACHE_PATH>/edgeworkers-cli/edgeworkers/<ewid>/

Laden Sie ein EdgeWorkers Combined Code Bundle herunter

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] <edgeworker-identifier> <revision-identifier>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--downloadPath <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

Wichtige Details

  1. Wenn --downloadPath nicht bereitgestellt wird oder nicht im lokalen Dateisystem gefunden wird, wird ein AkamaiCLI-Cache-Unterverzeichnis verwendet: <CLI_CACHE_PATH>/edgeworkers-cli/edgeworkers/<revid>/

Den Aktivierungsstatus der EdgeWorker-Version auflisten

Listen Sie den Aktivierungsstatus einer bestimmten EdgeWorker-ID auf.

Verwendung: akamai edgeworkers status [options] <edgeworker-identifier>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--versionId <versionId> Versionskennung
--activationId <activationId> Aktivierungskennung
--activeOnNetwork Beschränkt die Ergebnisse auf die Anzeige nur aktuell aktivierter Versionen
--network <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

Wichtige Details

  1. Sie dürfen nicht sowohl die Versions- als auch die Aktivierungskennung angeben.

Listen Sie den EdgeWorker-Revisionsverlauf auf

Listen Sie den Revisionsverlauf für eine bestimmte EdgeWorker-ID auf.

Verwendung: akamai edgeworkers list-revisions [options] <edgeworker-identifier>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--versionId <versionId> Versionskennung
--activationId <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 <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

Wichtige Details

  1. Das Netzwerk muss entweder STAGING oder PRODUCTION sein. Die Großschreibung wird auf Großbuchstaben normalisiert.

Rufen Sie Revisionsdetails eines EdgeWorker ab

Rufen Sie Details zu einer bestimmten Revision ab.

Verwendung: akamai edgeworkers get-revision [options] <edgeworker-identifier> <revision-identifier>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
Argument Existenz Beschreibung
Edgeworker-Identifikator erforderlich Ein eindeutiges ganzzahliges Handle für eine EdgeWorkers-Instanz
Revisionsidentifikator erforderlich Revisionskennung

Vergleichen Sie zwei Revisionsdetails eines EdgeWorkers

Zeigen Sie Abhängigkeitsunterschiede zwischen zwei Revisionen desselben EdgeWorker an.

Verwendung: akamai edgeworkers compare-revisions [options] <edgeworker-identifier> <revision-identifier> <revision-identifier>

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

Wichtige Details

  1. Beide Revisionskennungen müssen unterschiedlich sein.

Aktivieren Sie eine Revision eines EdgeWorkers

Aktivieren Sie eine Revision für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.

Verwendung: akamai edgeworkers activate-revision [options] <edgeworker-identifier> <revision-identifier>

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

Wichtige Details

  1. Die Revision wird im selben Netzwerk (PRODUCTION oder STAGING) reaktiviert, in dem sie zuvor aktiv war.

Pin-Revision eines EdgeWorkers

Anheften einer aktiven Revision für eine bestimmte EdgeWorker-ID.

Verwendung: akamai edgeworkers pin-revision [options] <edgeworker-identifier> <revision-identifier>

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

Wichtige Details

  1. Die Revision muss vor dem Anheften aktiviert werden.

Lösen Sie die Revision eines EdgeWorkers

Lösen Sie eine aktive angeheftete Revision für eine bestimmte EdgeWorker-ID.

Verwendung: akamai edgeworkers unpin-revision [options] <edgeworker-identifier> <revision-identifier>

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

Wichtige Details

  1. Die Revision muss angeheftet werden, bevor sie gelöst werden kann.

Rufen Sie Revisionsdetails eines EdgeWorker ab

Zeigen Sie Details für eine bestimmte Revision eines Verbundpakets an.

Verwendung: akamai edgeworkers get-revision-bom [options] <edgeworker-identifier> <revision-identifier>

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

Revisionsaktivierungen eines EdgeWorkers auflisten

Revisionsaktivierungsstatus einer bestimmten EdgeWorker-ID auflisten.

Verwendung: akamai edgeworkers list-revision-activations [options] <edgeworker-identifier>

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

Wichtige Details

  1. Sie dürfen nicht sowohl die Versions- als auch die Aktivierungskennung angeben.

  2. Das Netzwerk muss entweder STAGING oder PRODUCTION sein. Die Großschreibung wird auf Großbuchstaben normalisiert.

Aktivieren Sie einen EdgeWorker

Aktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.

Verwendung: akamai edgeworkers activate [options] <edgeworker-identifier> <network> <version-identifier>

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

Wichtige Details

  1. Das Netzwerk muss entweder STAGING oder PRODUCTION sein. Die Großschreibung wird auf Großbuchstaben normalisiert.

  2. Der Standortantwortheader wird mit der neuen EdgeWorker-Aktivierungs-ID bereitgestellt.

  3. Der Antworttext (JSON) für die EdgeWorker-Aktivierungsdetails wird mit dem Antwortcode 201 bereitgestellt.

Validieren Sie ein EdgeWorkers-Codepaket

Validiert eine Code-Bundle-Version, ohne das Code-Bundle hochzuladen

Verwendung: akamai edgeworkers validate [options] <bundlePath>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
Argument Existenz Beschreibung
bundlePath erforderlich Pfad zur Bundle-Datei im TGZ-Format

Wichtige Details

  1. Der Code-Bundle-Pfad muss im lokalen Dateisystem gefunden werden.

  2. Das Codepaket erwartet eine bereits gemäß der EdgeWorkers-Spezifikation erstellte TGZ-Datei.

Deaktivieren Sie einen EdgeWorker

Deaktivieren Sie eine Version für eine bestimmte EdgeWorker-ID in einem Akamai-Netzwerk.

Verwendung: akamai edgeworkers deactivate [options] <edgeworker-identifier> <network> <version-identifier>

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

Wichtige Details

  1. Das Netzwerk muss entweder STAGING oder PRODUCTION sein. Die Großschreibung wird auf Großbuchstaben normalisiert.

  2. Der Standortantwortheader wird mit der neuen EdgeWorker-Aktivierungs-ID bereitgestellt.

  3. Der Antworttext (JSON) für die EdgeWorker-Aktivierungsdetails wird mit dem Antwortcode 201 bereitgestellt.

Erstellen Sie ein EdgeWorkers-Authentifizierungstoken

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] <hostName>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--expiry <expiry> Ablaufdauer des Tokens in Minuten.
--format <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

Wichtige Details

  1. Der Wert --expiry muss zwischen 1 und 720 Minuten (12 Stunden) liegen. Der Standardwert beträgt 8 hours .

Klonen Sie eine EdgeWorker-ID

Ermöglicht dem Kunden, einen EdgeWorker von einer vorhandenen EdgeWorker-ID zu klonen.

Verwendung: akamai edgeworkers clone <edgeworker-identifier> <resourceTierId> [options]

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.

Wichtige Details

  1. Mit diesem Endpunkt kann der Benutzer durch Klonen eine andere Ressourcenebenen-ID für eine bestimmte EdgeWorker-ID auswählen. Das Klonen auf dieselbe Ressourcenebene schlägt fehl.

Verträge auflisten

Liste der Vertrags-IDs, auf die der Benutzer Zugriff hat.

Verwendung: akamai list-contracts

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben

Eigenschaften auflisten

Liste der Eigenschaften, die einer bestimmten EdgeWorker-ID zugeordnet sind.

Verwendung: akamai edgeworkers list-properties <edgeworker-identifier> [options]

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
--activeOnly Gibt nur aktive Eigenschaften zurück
Argument Existenz Beschreibung
Edgeworker-Identifikator erforderlich EdgeWorker-ID.

Wichtige Details

  1. Beachten Sie, dass der zurückgegebene boolesche Wert „limitedAccessToProperties“ wahr ist, wenn der Benutzer keinen Zugriff auf die Gruppe der obersten Ebene unter dem Konto hat oder wenn er nicht über die Administratorrolle für diese Gruppe verfügt.

Listenlimits

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

Ressourcenstufen für eine bestimmte Vertrags-ID auflisten

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

Wichtige Details

  1. Der Benutzer wird aufgefordert, eine Liste der Vertrags-IDs anzuzeigen, auf die er Zugriff hat. Die ausgewählte Vertrags-ID wird zum Abrufen der Ressourcenstufe verwendet.

  2. Um die Eingabeaufforderung für Automatisierungszwecke zu deaktivieren, kann die Vertrags-ID als Eingabe bereitgestellt werden.

Rufen Sie die Ressourcenebene für eine bestimmte EdgeWorker-ID ab

Kunden können Details zur Ressourcenstufe für eine bestimmte EdgeWorker-ID erhalten.

Verwendung: akamai show-restier <edgeworkerId>

Option Beschreibung
-h, --help Nutzungsinformationen ausgeben
Argument Existenz Beschreibung
EdgeworkerId erforderlich EdgeWorker-ID

Rufen Sie verfügbare EdgeWorkers-Berichtstypen ab

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

Wichtige Details

  1. Der Benutzer erhält eine Tabelle mit Report-IDs und einer Beschreibung jedes Berichts. Verwenden Sie eine bestimmte Report-ID mit dem Befehl get report um einen Bericht für einen bestimmten EdgeWorker abzurufen.

Holen Sie sich den EdgeWorker-Bericht

Rufen Sie einen Bericht für eine bestimmte EdgeWorker-ID ab.

Verwendung: akamai get report <reportId> <edgeworker-identifier>

Option Existenz Beschreibung
-h, --help optional Nutzungsinformationen ausgeben
-s, --startDate <startDate> erforderlich ISO 8601-Zeitstempel, der die Startzeit des EdgeWorkers-Berichts angibt.
-e, --endDate <startDate> optional ISO 8601-Zeitstempel, der die Endzeit des EdgeWorkers-Berichts angibt. Wenn nicht angegeben, wird als Endzeit standardmäßig die aktuelle Zeit verwendet.
--status <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 <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.

Wichtige Details

  1. Um eine Liste der verfügbaren Berichts-IDs zu erhalten, verwenden Sie den Befehl get reports .

  2. Die Option startDate ist eine erforderliche Option.

Alle Standardwerte eines Abschnitts in der Konfigurationsdatei auflisten

Rufen Sie alle Standardeigenschaften in einem Abschnitt der Konfigurationsdatei ab.

Verwendung: akamai config list

Option Existenz Beschreibung
-h, --help optional Nutzungsinformationen ausgeben

Wichtige Details

  1. Der Konfigurationsabschnitt ist standardmäßig default . Um einen anderen Abschnitt zu verwenden, sollten Benutzer den Befehl akamai edgeworkers mit der Option --configSection <configSeciont> angeben.

  2. Der gleiche Ansatz sollte für die folgenden config gelten.

Rufen Sie einen Standardwert eines Abschnitts in der Konfigurationsdatei ab

Rufen Sie einen bestimmten Standardwert in einem Abschnitt der Konfigurationsdatei ab.

Verwendung: akamai config get <key>

Option Existenz Beschreibung
-h, --help optional Nutzungsinformationen ausgeben
Argument Existenz Beschreibung
Schlüssel erforderlich Name der Standardeigenschaft

Festlegen/Aktualisieren eines Standardwerts eines Abschnitts in der Konfigurationsdatei

Ermöglicht Kunden das Festlegen/Aktualisieren eines bestimmten Standardwerts in einem Abschnitt der Konfigurationsdatei.

Verwendung: akamai config set <key> <value>

Option Existenz Beschreibung
-h, --help optional Nutzungsinformationen ausgeben
Argument Existenz Beschreibung
Schlüssel erforderlich Name der Standardeigenschaft
Wert erforderlich Wert der Standardeigenschaft

Setzen Sie einen Standardwert eines Abschnitts in der Konfigurationsdatei zurück

Ermöglicht Kunden, einen bestimmten Standardwert in einem Abschnitt der Konfigurationsdatei aufzuheben.

Verwendung: akamai config unset <key>

Option Existenz Beschreibung
-h, --help optional Nutzungsinformationen ausgeben
Argument Existenz Beschreibung
Schlüssel erforderlich Name der Standardeigenschaft

Massenspeicherung der Standardeigenschaft eines Abschnitts in der Konfigurationsdatei

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.

Wichtige Details

  1. Wenn der Kontext ein ungültiges Element enthält, überspringt der Befehl dieses Element und fährt fort.

Aktuelle Protokollierungsebene für den EdgeWorker anzeigen

Ermöglicht Kunden, die Details der Protokollierungsstufenüberschreibungen für den Edgeworker anzuzeigen.

Verwendung: akamai edgeworkers log-level get [options] <edgeworker-identifier> [logging-identifier]

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.

Wichtige Details

  1. Wenn die logging-identifier nicht angegeben ist, werden alle Protokollierungsstufenüberschreibungen angezeigt.

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

Legen Sie die aktuelle Protokollierungsstufe für den EdgeWorker fest

Ermöglicht Kunden, die Protokollierungsebene für den EdgeWorker festzulegen.

Verwendung: akamai edgeworkers log-level set [options] <edgeworker-identifier> <network> <level>

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

Wichtige Details

  1. Es ist nur die zuletzt erstellte Überschreibung der Protokollebene wirksam.

  2. Wenn die Außerkraftsetzung abläuft, wird die Protokollierungsebene auf die in der Datei bundle.json von Edgeworker angegebene zurückgesetzt.

  3. Wenn der Befehl erfolgreich ist, werden die Details zur Überschreibung der Protokollebene gedruckt, einschließlich 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.

  4. Wenn die Option --expires nicht angegeben ist, läuft die Außerkraftsetzung standardmäßig nie ab.

  5. Die Option --expires unterstützt sowohl die Eingabe in natürlicher Sprache als auch Standardzeitstempel. Die vollständigen Spezifikationen finden Sie in der Dokumentation chrono Pakets.

Beispiele

  1. Stellen Sie die Überschreibung der Protokollebene im Produktionsnetzwerk auf die Informationsebene ein, die in einer Stunde abläuft. 

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

  1. Stellen Sie die Überschreibung der Protokollebene im Staging-Netzwerk auf die Trace-Ebene ein, die am 13. August 2024 um 15:00 Uhr MESZ (mitteleuropäische Sommerzeit) abläuft. 

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

Ressourcen

Weitere Informationen zu EdgeWorkers finden Sie in den folgenden Ressourcen:

  • EdgeWorkers-Entwicklerseite

  • EdgeWorkers-Benutzerhandbuch

  • EdgeWorkers API-Handbuch

Probleme melden

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.

Mitwirken

Wir freuen uns über Beiträge von Akamai-Mitarbeitern, Kunden und anderen. Bevor Sie eine PR eröffnen, überprüfen Sie bitte Folgendes:

  1. Bitte fügen Sie einige Testfälle hinzu, um Ihre PR zu begleiten. Dadurch wird die im PR hinzugefügte oder geänderte Funktionalität überprüft und anderen bewiesen, dass Ihr Code funktioniert :)

  2. Bitte stellen Sie sicher, dass Ihr Code alle Pre-Commit-Prüfungen besteht. Ihr Code sollte erfolgreich erstellt werden, alle Komponententests bestehen und keine Flusenprobleme aufweisen.

  3. Alle PRs sollten auf die Entwicklung und nicht auf den Master abzielen. Zusammenführungen zum Master werden sofort für alle Kunden freigegeben.

Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle