Page d'accueil>Lié à la programmation>Autre code source
Télécharger

CLI EdgeWorkers

CLI EdgeWorkers L'interface de ligne de commande (CLI) EdgeWorkers accélère le processus d'enregistrement, de téléchargement, d'activation et de test des fonctions EdgeWorkers sur le réseau Akamai Edge.

Accédez à Akamai CLI pour EdgeKV pour obtenir des informations sur la façon de gérer les bases de données EdgeKV et d'appeler l'API EdgeKV à partir de la ligne de commande.

Exigences de configuration technique

Pour utiliser cet outil, vous avez besoin de :

  • CLI Akamai installée.

    • Si vous ne disposez pas de la CLI et que vous utilisez Homebrew sur un Mac, exécutez cette commande : brew install akamai

    • Vous pouvez également télécharger des binaires CLI spécifiques au système d'exploitation ou une image Docker

  • Informations d'identification EdgeGrid valides configurées via Akamai Control Center (voir Premiers pas avec les API)

  • Nœud version 14 ou supérieure

Installer ou mettre à jour les EdgeWorkers

  • Si le package CLI EdgeWorkers n'est pas installé, utilisez la commande CLI Akamai suivante pour installer le dernier package CLI EdgeWorkers :

Usage:
akamai install edgeworkers

  • Si la CLI est déjà installée, utilisez la commande CLI d'Akamai suivante pour installer le dernier package CLI EdgeWorkers qui inclut la fonctionnalité EdgeKV :

Usage:
akamai update edgeworkers

Fournir des propriétés de configuration par défaut

La CLI EdgeWorkers vous permet de définir des valeurs par défaut pour les options de commande. Il existe deux manières de créer un fichier de configuration :

  1. Créez un fichier de configuration ~/.akamai-cli/ew-config et stockez les propriétés comme suit :

 [défaut]
edgeworkerName=testEW
ID de groupe = 12345
ID version = 1-0-2

  1. Utilisez la commande config pour définir les propriétés par défaut : akamai edgeworkers config set <key> <value>

Les noms de propriétés disponibles sont affichés ici.

Présentation des commandes

EdgeWorkers CLI vous permet de gérer les fonctions EdgeWorkers en appelant l'API EdgeWorkers.

Congrès :

  • arguments facultatifs []

  • arguments requis <>

Usage:
akamai edgeworkers [options] [command]

Possibilités :

Syntaxe Description
-V, --version Affichez le numéro de version du programme EdgeWorkers CLI.
--déboguer Afficher les informations de débogage.
--edgerc <path> Utilisez les informations d'identification dans le fichier edgerc pour la commande. (L'emplacement du fichier par défaut est ~/.edgerc )
--section <name> Utilisez cette section dans le fichier edgerc . (La section par défaut est [default] )
--configSection <configSection> Utilisez cette section dans le fichier ew-config qui contient l'ensemble de propriétés de configuration par défaut. (La section par défaut est [default] )
--timeout <timeout> Vous pouvez spécifier une valeur de délai d'attente pour une commande en secondes afin de remplacer la valeur par défaut de 2 minutes. Par exemple, si vous ajoutez « --timeout 10 » à une commande, celle-ci expirera si le serveur met plus de 10 secondes à répondre.
--json [path] Écrivez la sortie CLI au format JSON dans le chemin fourni en option. Si le chemin n'est pas fourni, écrivez la sortie JSON dans le répertoire personnel de la CLI
--jsonout Écrivez la sortie CLI au format JSON sur la sortie standard.
-h, --aide Afficher les informations d'utilisation pour EdgeWorkers CLI.

Commandes :

Commande | Alias Description
aide [command] Afficher les informations d'utilisation pour la commande donnée.
groupes de liste | lg [group-identifier] Le développeur client peut trouver son niveau d'accès EdgeWorkers par groupe de contrôle d'accès Luna.
identifiants de liste | li [options] [edgeworker-identifier] Liste les identifiants EdgeWorker actuellement enregistrés.
s'inscrire | create-id <group-identifier> <edgeworker-name> Enregistrez un nouvel identifiant EdgeWorker à référencer dans le comportement du gestionnaire de propriétés.
identifiant de mise à jour | ui <edgeworker-identifier> <group-identifier> <edgeworker-name> [options] Permet au développeur client de mettre à jour les attributs Luna ACG ou Name d'un identifiant EdgeWorker existant.
supprimer-id | delete-id [options] <edgeworker-identifier> Supprimez définitivement un identifiant EdgeWorker existant.
liste-versions | lv <edgeworker-identifier> [version-identifier] Répertoriez les informations de version d’un ID EdgeWorker donné.
télécharger | créer-version [options] <edgeworker-identifier> Crée une nouvelle version d'un ID EdgeWorker donné qui inclut le bundle de codes.
supprimer-version | delete-version [options] <edgeworker-identifier> <version-identifier> Supprimez définitivement une version existante d’un identifiant EdgeWorker donné.
télécharger | version de téléchargement [options] <edgeworker-identifier> <version-identifier> Téléchargez le bundle de codes d'une version EdgeWorker.
télécharger-révision | dr [options] <edgeworker-identifier> <revision-identifier> Téléchargez le bundle de codes combiné qui contient le code et les dépendances exécutés par EdgeWorker.
statut | liste-activations [options] <edgeworker-identifier> Répertoriez l’état d’activation d’un identifiant EdgeWorker donné.
liste-révisions | lr [options] <edgeworker-identifier> Répertoriez l’historique des révisions pour un ID EdgeWorker donné.
obtenir-révision | gr <edgeworker-identifier> <revision-identifier> Obtenez des détails sur une révision spécifique.
comparer-révisions | cr <edgeworker-identifier> <revision-identifier> <revision-identifier> Affichez les différences de dépendance entre deux révisions du même EdgeWorker.
activer-révision | ar [options] <edgeworker-identifier> <revision-identifier> Activez une révision pour un identifiant EdgeWorker donné sur Akamai Network.
pin-revision [options] <edgeworker-identifier> <revision-identifier> Épinglez une révision active pour un ID EdgeWorker donné.
unpin-revision [options] <edgeworker-identifier> <revision-identifier> Supprimez une révision épinglée active pour un ID EdgeWorker donné.
obtenir-révision-bom | gb [options] <edgeworker-identifier> <revision-identifier> Afficher les détails d'une révision spécifique d'un ensemble composite.
liste-révision-activations | lra [options] <edgeworker-identifier> Répertoriez l’état d’activation de la révision d’un ID EdgeWorker donné.
activer | av <edgeworker-identifier> <network> <versionId> Activez une version pour un identifiant EdgeWorker donné sur un réseau Akamai.
désactiver | deact <edgeworker-identifier> <network> <versionId> Désactivez une version pour un identifiant EdgeWorker donné sur un réseau Akamai.
valider | vv <bundlePath> Valide une version d’un bundle de codes sans télécharger le bundle de codes.
créer-un jeton d'authentification | auth [options] <hostName> Génère un jeton d'authentification qui peut être utilisé pour obtenir des en-têtes de réponse de débogage EdgeWorker détaillés. Vous avez besoin d'au moins la version 1.7.1 de la CLI EdgeWorkers pour exécuter cette commande.
cloner | cloner <edgeworker-identifier> <resourceTierId> [options] Clone un EdgeWorker à partir de l'ID EdgeWorker existant.
liste-contrats | li-contrats [options] Liste des identifiants de contrat auxquels l'utilisateur a accès.
liste-propriétés | lp <edgeworker-identifier> [options] Liste des propriétés associées à un ID EdgeWorker donné.
limites de liste | Li-limites Consultez les différentes limites imposées par EdgeWorkers sur le nombre d'activations, les ID EdgeWorkers et les versions que vous pouvez déployer.
liste-restiers | li-restiers [options] Répertoriez les niveaux de ressources qui peuvent être utilisés pour créer ou cloner l'ID EdgeWorker.
show-restier | show-restier <edgeworker-identifier> Les clients peuvent obtenir des détails sur le niveau de ressource pour un identifiant EdgeWorker spécifique.
obtenir des rapports Obtenez une liste de tous les rapports EdgeWorkers disponibles.
obtenir le rapport <reportId> <edgeworker-identifier> [options] Obtenez un rapport EdgeWorkers pour un ID EdgeWorker spécifique.
liste de configuration Obtenez toutes les valeurs dans le fichier de configuration.
config obtient <key> Obtenez une valeur de configuration à partir d'une section du fichier de configuration.
ensemble de configuration <key> <value> Définissez une valeur de configuration dans une section.
config save -p <properties> Enregistrez les propriétés de configuration dans une section.
config non défini <key> Supprimez une valeur de configuration dans une section.

Répertorier les groupes d'autorisations avec accès EdgeWorkers

Le développeur client peut trouver son niveau d'accès EdgeWorkers par groupe de contrôle d'accès Luna.

Utilisation : akamai edgeworkers list-groups [options] [group-identifier]

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant de groupe facultatif Valeur du Luna Access Group (généralement un nombre) pour vérifier les autorisations EdgeWorkers

Détails clés

  1. La sortie est filtrée uniquement sur les groupes de contrôle d'accès Luna qui disposent d'au moins une fonctionnalité EdgeWorkers.

  2. Les fonctionnalités peuvent être : VIEW,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE

Répertorier les identifiants EdgeWorker existants

Liste les identifiants EdgeWorker actuellement enregistrés.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--groupId <groupId> Filtrer la liste des identifiants EdgeWorker par groupe d'autorisations
--resourceTierId <resourceTierId> Filtrer l'ID EdgeWorker par niveau de ressource
Argument Existence Description
identifiant-edgeworker facultatif Un handle entier unique pour une instance EdgeWorkers

Enregistrer un nouvel identifiant EdgeWorker

Enregistrez un nouvel identifiant EdgeWorker à référencer dans le comportement du gestionnaire de propriétés.

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

Option Description
--resourceTierId Nouvel identifiant de niveau de ressource auquel EdgeWorker sera associé.
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant de groupe requis Valeur du Luna Access Group (généralement un nombre) pour vérifier les autorisations EdgeWorkers
nom du travailleur de bord requis Étiquette courte lisible par l'homme décrivant une instance EdgeWorkers

Détails clés

  1. L’en-tête de réponse d’emplacement sera fourni avec le nouvel identifiant EdgeWorker.

  2. Le corps de réponse (JSON) des détails de l'identifiant EdgeWorker sera fourni avec le code de réponse 201.

  3. Pour désactiver les invites à des fins d'automatisation, "resourceTierId" peut être fourni en entrée.

Mettre à jour les informations de l'identifiant EdgeWorker

Permet au développeur client de mettre à jour les attributs Luna ACG ou Name d'un identifiant EdgeWorker existant.

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

Option Description
--resourceTierId Nouvel identifiant de niveau de ressource auquel EdgeWorker sera associé
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de groupe requis Valeur du Luna Access Group (généralement un nombre) pour vérifier les autorisations EdgeWorkers
nom du travailleur de bord requis Étiquette courte lisible par l'homme décrivant une instance EdgeWorkers

Détails clés

  1. L'API nécessite que groupId et name soient fournis même si vous ne modifiez qu'un de ces attributs.

  2. Le corps de réponse (JSON) des détails de l'identifiant EdgeWorker sera fourni avec 200 codes de réponse.

  3. L’ID de niveau de ressource fourni doit être le même que celui que possède déjà l’ID EdgeWorker. Afin de fournir un identifiant de niveau de ressource différent, veuillez utiliser l'opération de clonage.

Supprimer l'identifiant EdgeWorker existant

Supprimez définitivement un identifiant EdgeWorker existant.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--noPrompt Ignorer l'invite de confirmation de suppression
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers

Détails clés

  1. La suppression d'un ID EdgeWorker n'est possible que s'il n'a aucune version actuellement active ou en cours d'activation sur le réseau Akamai.

  2. Assurez-vous qu’aucune propriété active n’est associée à un EdgeWorker avant la suppression.

Répertorier les versions d'EdgeWorker

Répertoriez les informations de version d’un ID EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de version facultatif Un descripteur entier unique vers la version d'une instance EdgeWorkers

Détails clés

  1. L'ensemble de résultats est trié en fonction d'une valeur de séquence de téléchargement qui n'est pas affichée (un entier incrémenté interne).

  2. Les versions EdgeWorker sont des chaînes définies par le client.

Télécharger une nouvelle version d'EdgeWorker

Crée une nouvelle version d'un ID EdgeWorker donné qui inclut le bundle de codes.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--bundle <bundlePath> Chemin d'accès au fichier bundle au format tgz
--codeDir <workingDirectory> Répertoire de travail contenant les fichiers main.js et bundle.json
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers

Détails clés

  1. L'un des éléments --bundle ou --codeDir (mais pas les deux) doit être fourni.

  2. Les chemins et les fichiers des groupes de codes doivent être trouvés sur le système de fichiers local.

  3. --bundle attend un fichier tgz déjà construit selon la spécification EdgeWorkers.

  4. --codeDir attend un chemin de répertoire qui contient à la fois le main.js (fichier d'événements) et bundle.json (fichier manifeste).

  5. L'option --codeDir fournira la validation du format bundle.json.

  6. --codeDir ne contient pas d'autres répertoires ou codes au-delà de main.js et bundle.json.

  7. --codeDir construira le fichier tarball (tgz) si la validation du fichier réussit.

  8. Le service comparera la somme de contrôle de la nouvelle archive tar avec les archives tar précédemment téléchargées pour le même identifiant EdgeWorker ( ewId ). Si une correspondance est trouvée, la création d'une nouvelle version est interdite.

  9. versionId est généré par le client et sera extrait de bundle.json.

  10. L’en-tête de réponse d’emplacement sera fourni avec le nouvel identifiant de version EdgeWorker.

  11. Le corps de réponse (JSON) des détails de la version EdgeWorker sera fourni avec le code de réponse 201.

Supprimer la version EdgeWorker existante

Supprimez définitivement une version existante d’un identifiant EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--noPrompt Ignorer l'invite de confirmation de suppression
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de version requis Un descripteur entier unique vers la version d'une instance EdgeWorkers

Détails clés

  1. La suppression d'une version n'est possible que si elle n'est pas actuellement active ou en cours d'activation sur le réseau Akamai.

  2. Si la version est actuellement active, elle devra être désactivée avant de pouvoir être supprimée.

Téléchargez un ensemble de codes EdgeWorkers

Téléchargez le bundle de codes d'une version EdgeWorker.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--downloadPath <downloadPath> Chemin d'accès pour stocker le fichier bundle téléchargé ; la valeur par défaut est le répertoire personnel CLI s'il n'est pas fourni.
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de version requis Un descripteur entier unique vers la version d'une instance EdgeWorkers

Détails clés

  1. Si --downloadPath n'est pas fourni ou n'est pas trouvé sur le système de fichiers local, un sous-répertoire de cache AkamaiCLI sera utilisé : <CLI_CACHE_PATH>/edgeworkers-cli/edgeworkers/<ewid>/

Téléchargez un ensemble de codes combinés EdgeWorkers

Téléchargez le bundle de codes combiné qui contient le code et les dépendances exécutés par EdgeWorker.

Utilisation : akamai edgeworkers download-revision [options] <edgeworker-identifier> <revision-identifier>

Option Description
-h, --aide informations sur l'utilisation de la sortie
--downloadPath <downloadPath> Chemin d'accès pour stocker le fichier de bundle combiné téléchargé ; la valeur par défaut est le répertoire personnel CLI s'il n'est pas fourni.
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Un identifiant de révision unique spécifique à une instance EdgeWorkers

Détails clés

  1. Si --downloadPath n'est pas fourni ou n'est pas trouvé sur le système de fichiers local, un sous-répertoire de cache AkamaiCLI sera utilisé : <CLI_CACHE_PATH>/edgeworkers-cli/edgeworkers/<revid>/

Répertorier l'état d'activation de la version EdgeWorker

Répertoriez l’état d’activation d’un identifiant EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--versionId <versionId> Identifiant de version
--activationId <activationId> Identifiant d'activation
--activeOnNetwork Limite les résultats pour afficher uniquement les versions actuellement activées
--réseau <network> Limite les résultats aux versions qui ont été activées sur un réseau spécifique (STAGING ou PRODUCTION)
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers

Détails clés

  1. Vous ne pouvez pas fournir à la fois les identifiants de version et d’activation.

Répertorier l'historique des révisions d'EdgeWorker

Répertoriez l’historique des révisions pour un ID EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--versionId <versionId> Identifiant de version
--activationId <activationId> Identifiant d'activation
--pinnedOnly Limite les résultats pour afficher uniquement les révisions actuellement ou précédemment épinglées
--actuellementÉpinglé Limite les résultats pour afficher uniquement les révisions actuellement épinglées
--réseau <network> Limite les résultats aux versions qui ont été activées sur un réseau spécifique (STAGING ou PRODUCTION)
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers

Détails clés

  1. Le réseau doit être soit STAGE, soit PRODUCTION. Les majuscules seront normalisées en majuscules.

Obtenir les détails de la révision d'un EdgeWorker

Obtenez des détails sur une révision spécifique.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Identifiant de révision

Comparez les détails de deux révisions d'un EdgeWorker

Affichez les différences de dépendance entre deux révisions du même EdgeWorker.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Identifiant de la première révision
identifiant de révision requis Identifiant de la deuxième révision

Détails clés

  1. Les deux identifiants de révision doivent être différents.

Activer une révision d'un EdgeWorker

Activez une révision pour un ID EdgeWorker donné sur un réseau Akamai.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--note Note pour préciser pourquoi la révision est réactivée
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Identifiant de révision

Détails clés

  1. La révision sera réactivée sur le même réseau (PRODUCTION ou STAGING) sur lequel elle était précédemment active.

Révision des broches d'un EdgeWorker

Épinglez une révision active pour un ID EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--note Remarque pour préciser pourquoi la révision est épinglée
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Identifiant de révision

Détails clés

  1. La révision doit être activée avant l’épinglage.

Supprimer la révision d'un EdgeWorker

Supprimez une révision épinglée active pour un ID EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--note Remarque pour préciser pourquoi la révision est désépinglée
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Identifiant de révision

Détails clés

  1. La révision doit être épinglée avant de la désépingler.

Obtenir les détails de la révision d'un EdgeWorker

Afficher les détails d'une révision spécifique d'un ensemble composite.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--activeVersions Limiter les résultats pour afficher uniquement les versions actives
--actuellementPinnedRevisions Affiche des informations supplémentaires sur la révision actuellement épinglée
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
identifiant de révision requis Identifiant de révision

Liste des activations de révision d'un EdgeWorker

Répertoriez l’état d’activation de la révision d’un ID EdgeWorker donné.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--versionId Identificateur de version
--activationId Identifiant d'activation
--réseau Limite les résultats aux versions qui ont été activées sur un réseau spécifique (STAGING ou PRODUCTION)
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers

Détails clés

  1. Vous ne pouvez pas fournir à la fois les identifiants de version et d’activation.

  2. Le réseau doit être soit STAGE, soit PRODUCTION. Les majuscules seront normalisées en majuscules.

Activer un EdgeWorker

Activez une version pour un identifiant EdgeWorker donné sur un réseau Akamai.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
réseau requis Étiquette pour laquelle l'activation d'Akamai Network (STAGING ou PRODUCTION) doit être envoyée à
identifiant de version requis Un descripteur entier unique vers la version d'une instance EdgeWorkers

Détails clés

  1. Le réseau doit être soit STAGE, soit PRODUCTION. Les majuscules seront normalisées en majuscules.

  2. L’en-tête de réponse d’emplacement sera fourni avec le nouvel identifiant d’activation EdgeWorker.

  3. Le corps de réponse (JSON) des détails d’activation d’EdgeWorker sera fourni avec le code de réponse 201.

Valider un ensemble de codes EdgeWorkers

Valide une version d'un bundle de codes sans télécharger le bundle de codes

Utilisation : akamai edgeworkers validate [options] <bundlePath>

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
bundlePath requis Chemin d'accès au fichier bundle au format tgz

Détails clés

  1. Le chemin du bundle de codes doit être trouvé sur le système de fichiers local.

  2. Le bundle de codes attend un fichier tgz déjà créé selon la spécification EdgeWorkers.

Désactiver un EdgeWorker

Désactivez une version pour un identifiant EdgeWorker donné sur un réseau Akamai.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Un handle entier unique pour une instance EdgeWorkers
réseau requis Étiquette pour laquelle l'activation d'Akamai Network (STAGING ou PRODUCTION) doit être envoyée à
identifiant de version requis Un descripteur entier unique vers la version d'une instance EdgeWorkers

Détails clés

  1. Le réseau doit être soit STAGE, soit PRODUCTION. Les majuscules seront normalisées en majuscules.

  2. L’en-tête de réponse d’emplacement sera fourni avec le nouvel identifiant d’activation EdgeWorker.

  3. Le corps de réponse (JSON) des détails d’activation d’EdgeWorker sera fourni avec le code de réponse 201.

Créer un jeton d'authentification EdgeWorkers

Génère un jeton d'authentification qui peut être utilisé pour obtenir des en-têtes de réponse de débogage EdgeWorker détaillés. Vous avez besoin d'au moins la version 1.7.1 de la CLI EdgeWorkers pour exécuter cette commande. Utilisez l'option -V, --version pour afficher le numéro de version actuel de la CLI EdgeWorkers.

Utilisation : akamai edgeworkers create-auth-token [options] <hostName>

Option Description
-h, --aide informations sur l'utilisation de la sortie
--expiration <expiry> Durée d'expiration du jeton, en minutes.
--format <format> Format dans lequel la sortie sera imprimée
Argument Existence Description
Nom d'hôte facultatif Nom d'hôte de la propriété. Si aucun nom d'hôte n'est fourni, un jeton est créé pour tous les hôtes ( /* ) sous la propriété. Ex : www.test.com, www.test1.com

Détails clés

  1. La valeur --expiry doit être comprise entre 1 et 720 minutes (12 heures). La valeur par défaut est de 8 hours .

Cloner un identifiant EdgeWorker

Permet au client de cloner un EdgeWorker à partir d'un identifiant EdgeWorker existant.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--ewName Nom du EdgeWorker
--IDgroupe Identifiant du groupe
Argument Existence Description
ID de niveau de ressource requis ID du niveau de ressource sur lequel EdgeWorker sera cloné.

Détails clés

  1. Ce point de terminaison permet à l'utilisateur de sélectionner un ID de niveau de ressource différent pour un ID EdgeWorker spécifique en le clonant. Le clonage vers le même niveau de ressources échouera.

Liste des contrats

Liste des identifiants de contrat auxquels l'utilisateur a accès.

Utilisation : akamai list-contracts

Option Description
-h, --aide informations sur l'utilisation de la sortie

Propriétés de la liste

Liste des propriétés associées à un ID EdgeWorker spécifique.

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

Option Description
-h, --aide informations sur l'utilisation de la sortie
--activeOnly Renvoie uniquement les propriétés actives
Argument Existence Description
identifiant-edgeworker requis Identifiant EdgeWorker.

Détails clés

  1. Notez que le booléen renvoyé limitedAccessToProperties est vrai si l'utilisateur n'a pas accès au groupe de niveau supérieur sous le compte ou s'il n'a pas le rôle d'administrateur pour ce groupe.

Limites de la liste

Répertoriez les différentes limites imposées par EdgeWorkers sur le nombre d'activations, les ID EdgeWorkers et les versions que vous pouvez déployer.

Utilisation : akamai edgeworkers list-limits [options]

Option Description
-h, --aide informations sur l'utilisation de la sortie

Répertorier les niveaux de ressources pour un ID de contrat spécifique

Répertoriez les niveaux de ressources qui peuvent être utilisés pour créer ou cloner des ID EdgeWorker.

Utilisation : akamai list-restiers

Option Description
--IDcontrat Niveaux de ressources pour l’ID de contrat spécifié.
-h, --aide informations sur l'utilisation de la sortie

Détails clés

  1. L'utilisateur sera invité à indiquer la liste des identifiants de contrat auxquels l'utilisateur a accès. L'ID de contrat sélectionné sera utilisé pour récupérer le niveau de ressource.

  2. Pour désactiver l'invite à des fins d'automatisation, l'identifiant du contrat peut être fourni en entrée.

Récupérer le niveau de ressource pour un identifiant EdgeWorker spécifique

Les clients peuvent obtenir des détails sur le niveau de ressource pour un identifiant EdgeWorker spécifique.

Utilisation : akamai show-restier <edgeworkerId>

Option Description
-h, --aide informations sur l'utilisation de la sortie
Argument Existence Description
ID du travailleur de bord requis Identifiant EdgeWorker

Obtenir les types de rapports EdgeWorkers disponibles

Répertoriez les types de rapports disponibles qui peuvent être générés pour un ID EdgeWorker.

Utilisation : akamai get reports

Option Description
-h, --aide informations sur l'utilisation de la sortie

Détails clés

  1. L'utilisateur recevra un tableau avec les identifiants de rapport et une description de chaque rapport. Utilisez un reportId donné avec la commande get report pour obtenir un rapport pour un EdgeWorker donné.

Obtenir le rapport EdgeWorker

Obtenez un rapport pour un ID EdgeWorker donné.

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

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
-s, --startDate <startDate> requis Horodatage ISO 8601 indiquant l’heure de début du rapport EdgeWorkers.
-e, --endDate <startDate> facultatif Horodatage ISO 8601 indiquant l’heure de fin du rapport EdgeWorkers. Si elle n’est pas spécifiée, l’heure de fin est par défaut l’heure actuelle.
--statut <status> facultatif Chaîne séparée par des virgules à filtrer par statut EdgeWorkers. Valeurs : success , genericError , unknownEdgeWorkerId , unimplementedEventHandler , runtimeError , executionError , timeoutError , resourceLimitHit , cpuTimeoutError , wallTimeoutError , initCpuTimeoutError , initWallTimeoutError .
--ev, --eventHandlers <eventHandlers> facultatif Chaîne séparée par des virgules pour filtrer les EdgeWorkers en fonction de l'événement qui les déclenche. Valeurs : onClientRequest , onOriginRequest , onOriginResponse , onClientResponse , responseProvider .
Argument Existence Description
ID du rapport requis Type de rapport.
identifiant-edgeworker requis Identifiant EdgeWorker.

Détails clés

  1. Pour obtenir la liste des ID de rapport disponibles, utilisez la commande get reports .

  2. L’option startDate est une option obligatoire.

Répertorier toutes les valeurs par défaut d'une section dans le fichier de configuration

Obtenez toutes les propriétés par défaut dans une section du fichier de configuration.

Utilisation : akamai config list

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie

Détails clés

  1. La section de configuration est default par défaut. Pour utiliser une autre section, les utilisateurs doivent spécifier la commande akamai edgeworkers avec l'option --configSection <configSeciont> .

  2. La même approche devrait s'appliquer aux commandes config suivantes.

Obtenir une valeur par défaut d'une section dans le fichier de configuration

Obtenez une valeur par défaut spécifique dans une section du fichier de configuration.

Utilisation : akamai config get <key>

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
Argument Existence Description
clé requis Nom de la propriété par défaut

Définir/mettre à jour une valeur par défaut d'une section dans le fichier de configuration

Permet aux clients de définir/mettre à jour une valeur par défaut spécifique dans une section du fichier de configuration.

Utilisation : akamai config set <key> <value>

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
Argument Existence Description
clé requis Nom de la propriété par défaut
valeur requis Valeur de la propriété par défaut

Annuler la valeur par défaut d'une section dans le fichier de configuration

Permet aux clients de supprimer une valeur par défaut spécifique dans une section du fichier de configuration.

Utilisation : akamai config unset <key>

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
Argument Existence Description
clé requis Nom de la propriété par défaut

Enregistrer en bloc la propriété par défaut d'une section dans le fichier de configuration

Permet aux clients d'enregistrer les valeurs par défaut en masse.

Utilisation : akamai config save [options]

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
-p, --propriétés requis Propriétés de configuration. Utilisez le format 'key=value' pour définir une propriété et un espace blanc pour les diviser.

Détails clés

  1. Si le contexte contient un élément non valide, la commande ignorera cet élément et continuera.

Afficher le niveau de journalisation actuel pour EdgeWorker

Permet aux clients d'afficher les détails des remplacements de niveau de journalisation pour Edgeworker.

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

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
Argument Existence Description
identifiant-edgeworker requis Identifiant EdgeWorker pour lequel afficher les informations de remplacement du niveau de journalisation.
identifiant de journalisation facultatif ID de journalisation du remplacement du niveau de journalisation à afficher.

Détails clés

  1. Si l' logging-identifier n'est pas spécifié, tous les remplacements de niveau de journalisation seront affichés.

  2. L' logging-identifier est une constante numérique identifiant un remplacement de niveau de journalisation. Il peut être obtenu lors de la création du remplacement, ou en répertoriant tous les remplacements sans fournir l'argument facultatif et en recherchant le champ loggingId du remplacement spécifique.

Définir le niveau de journalisation actuel pour EdgeWorker

Permet aux clients de définir le niveau de journalisation pour EdgeWorker.

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

Option Existence Description
-h, --aide facultatif informations sur l'utilisation de la sortie
--expire facultatif Spécifie la durée pendant laquelle le remplacement du niveau de journalisation de l'utilisateur sera appliqué. Une fois ce délai passé, le niveau de journalisation revient à la valeur par défaut spécifiée dans le bundle.
--ds2Id facultatif ID Datastream à utiliser avec celui spécifié dans le fichier bundle.json d'EdgeWorker.
Argument Existence Description
identifiant-edgeworker requis Identifiant EdgeWorker pour lequel modifier le niveau de journalisation.
réseau requis Réseau pour lequel appliquer le nouveau niveau de journalisation. Soit « production », soit « mise en scène ».
niveau requis Nouveau niveau de journalisation à appliquer pour EdgeWorker. Pour connaître les valeurs possibles, consultez la documentation de journalisation client.

Détails clés

  1. Seul le remplacement du niveau de journalisation le plus récemment créé est en vigueur.

  2. Lorsque le remplacement expire, le niveau de journalisation est réinitialisé à celui spécifié dans le fichier bundle.json d'Edgeworker.

  3. Si la commande réussit, les détails du remplacement du niveau de journalisation sont imprimés, qui incluent loggingId de journalisation du remplacement. Le loggingId peut être utilisé pour obtenir ces détails à tout moment en utilisant la sous log-level get et en le transmettant à un argument facultatif logging-identifier .

  4. Si l’option --expires n’est pas spécifiée, la valeur par défaut est que le remplacement n’expire jamais.

  5. L'option --expires prend en charge à la fois la saisie en langage naturel et les horodatages standard. Veuillez vous référer à la documentation du package chrono pour les spécifications complètes.

Exemples

  1. Définissez le remplacement du niveau de journalisation sur le réseau de production sur le niveau d'informations, qui expirera dans 1 heure. 

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

  1. Définissez le remplacement du niveau de journalisation sur le réseau intermédiaire sur le niveau de trace, qui expirera à 15 h 00 CEST (heure d'été d'Europe centrale) le 13 août 2024. 

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

Ressources

Pour plus d'informations sur EdgeWorkers, reportez-vous aux ressources suivantes :

  • Page des développeurs EdgeWorkers

  • Guide de l'utilisateur EdgeWorkers

  • Guide de l'API EdgeWorkers

Problèmes de signalement

Vous êtes prêt, bon codage ! Si vous rencontrez des problèmes avec la CLI EdgeWorkers, signalez-les comme un problème github. N'hésitez pas à créer une pull request avec le correctif ou la suggestion.

Contribuer

Nous apprécions les contributions du personnel d'Akamai, des clients ou autres. Avant d'ouvrir un PR, veuillez vérifier les points suivants :

  1. Veuillez ajouter quelques cas de test pour accompagner votre PR. Cela vérifie la fonctionnalité ajoutée ou modifiée dans le PR et prouve aux autres que votre code fonctionne :)

  2. Veuillez vous assurer que votre code réussit toutes les vérifications préalables à la validation. Votre code doit être construit avec succès, réussir tous les tests unitaires et ne présenter aucun problème de peluchage.

  3. Tous les PR devraient cibler le développement et non le maîtrise. Les fusions vers le master seront immédiatement diffusées auprès de tous les clients.

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout