CLI de EdgeWorkers La interfaz de línea de comandos (CLI) de EdgeWorkers acelera el proceso de registro, carga, activación y prueba de las funciones de EdgeWorkers en la red Akamai Edge.
Vaya a Akamai CLI para EdgeKV para obtener información sobre cómo administrar las bases de datos de EdgeKV y llamar a la API de EdgeKV desde la línea de comandos.
Para utilizar esta herramienta necesitas:
CLI de Akamai instalada.
Si no tiene la CLI y está utilizando Homebrew en una Mac, ejecute este comando: brew install akamai
También puede descargar archivos binarios CLI específicos del sistema operativo o una imagen de Docker.
Credenciales EdgeGrid válidas configuradas a través del Centro de control de Akamai (consulte Introducción a las API)
Versión de nodo 14 o superior
Si no tiene instalado el paquete CLI de EdgeWorkers, utilice el siguiente comando CLI de Akamai para instalar el paquete CLI de EdgeWorkers más reciente:
Uso:
akamai install edgeworkers
Si ya tiene la CLI instalada, utilice el siguiente comando CLI de Akamai para instalar el paquete CLI de EdgeWorkers más reciente que incluye la funcionalidad EdgeKV:
Uso:
akamai update edgeworkers
La CLI de EdgeWorkers le permite establecer valores predeterminados para las opciones de comando. Hay dos formas de crear un archivo de configuración:
Cree un archivo de configuración ~/.akamai-cli/ew-config y almacene las propiedades de la siguiente manera:
[por defecto] edgeworkerName=pruebaEW ID de grupo = 12345 ID de versión = 1-0-2
Utilice el comando config para establecer las propiedades predeterminadas: akamai edgeworkers config set
Los nombres de propiedades disponibles se muestran aquí.
La CLI de EdgeWorkers le permite administrar las funciones de EdgeWorkers llamando a la API de EdgeWorkers.
Convenciones:
argumentos opcionales []
argumentos requeridos <>
Uso:
akamai edgeworkers [options] [command]
Opciones:
| Sintaxis | Descripción |
|---|---|
| -V, --versión | Muestre el número de versión del programa CLI de EdgeWorkers. |
| --depurar | Mostrar información de depuración. |
--edgerc | Utilice las credenciales en el archivo edgerc para el comando. (La ubicación predeterminada del archivo es ~/.edgerc ) |
--sección | Utilice esta sección en el archivo edgerc . (La sección predeterminada es [predeterminada] ) |
--configSection | Utilice esta sección en el archivo ew-config que contiene las propiedades de configuración predeterminadas establecidas. (La sección predeterminada es [predeterminada] ) |
--timeout | Puede especificar un valor de tiempo de espera para un comando en segundos para anular el valor predeterminado de 2 minutos. Por ejemplo, si agrega "--timeout 10" a un comando, el tiempo de espera expirará si el servidor tarda más de 10 segundos en responder. |
--json [path] | Escriba la salida CLI como JSON en la ruta proporcionada opcionalmente. Si no se proporciona la ruta, escriba la salida JSON en el directorio de inicio de CLI |
| --jsonout | Escriba la salida CLI como JSON en la salida estándar. |
| -h, --ayuda | Muestra información de uso para la CLI de EdgeWorkers. |
Comandos:
| Comando | Alias | Descripción |
|---|---|
ayuda [command] | Muestra información de uso para el comando dado. |
grupos de listas | lg [group-identifier] | El desarrollador del cliente puede encontrar su nivel de acceso de EdgeWorkers por grupo de control de acceso de Luna. |
identificadores de lista | li [options] [edgeworker-identifier] | Enumere los ID de EdgeWorker actualmente registrados. |
registrarse | create-id | Registre una nueva identificación de EdgeWorker para hacer referencia en el comportamiento del Administrador de propiedades. |
ID de actualización | ui | Permite al desarrollador del cliente actualizar los atributos Luna ACG o Nombre de un identificador EdgeWorker existente. |
eliminar-id | eliminar-id [options] | Elimine permanentemente una identificación de EdgeWorker existente. |
versiones de lista | lv | Enumere la información de la versión de un ID de EdgeWorker determinado. |
subir | crear-versión [options] | Crea una nueva versión de un ID de EdgeWorker determinado que incluye el paquete de código. |
eliminar versión | eliminar versión [options] | Eliminar permanentemente una versión existente de un ID de EdgeWorker determinado. |
descargar | versión de descarga [options] | Descargue el paquete de códigos de una versión de EdgeWorker. |
descargar-revisión | dr [options] | Descargue el paquete de código combinado que contiene el código y las dependencias que ejecuta EdgeWorker. |
estado | activaciones de lista [options] | Enumere el estado de activación de un ID de EdgeWorker determinado. |
revisiones-de-lista | lr [options] | Enumere el historial de revisión de un ID de EdgeWorker determinado. |
obtener revisión | gr | Obtenga detalles para una revisión específica. |
comparar-revisiones | cr | Vea las diferencias de dependencia entre dos revisiones del mismo EdgeWorker. |
activar-revisión | ar [options] | Active una revisión para un ID de EdgeWorker determinado en la red Akamai. |
revisión-pin [options] | Fije una revisión activa para una ID de EdgeWorker determinada. |
desanclar-revisión [options] | Desanclar una revisión fijada activa para un ID de EdgeWorker determinado. |
obtener-revisión-nacer | gb [options] | Ver detalles de una revisión específica de un paquete compuesto. |
lista-revision-activaciones | lra [options] | Listar el estado de activación de revisión de un ID de EdgeWorker determinado. |
activar | av | Active una versión para un ID de EdgeWorker determinado en una red Akamai. |
desactivar | deact | Desactive una versión para un ID de EdgeWorker determinado en una red Akamai. |
validar | vv | Valida una versión del paquete de códigos sin cargar el paquete de códigos. |
crear-token-autenticación | autenticación [options] | Genera un token de autenticación que se puede utilizar para obtener encabezados de respuesta de depuración detallados de EdgeWorker. Necesita al menos la versión 1.7.1 de la CLI de EdgeWorkers para ejecutar este comando. |
clonar | clonar | Clona un EdgeWorker a partir del ID de EdgeWorker existente. |
contratos de lista | contratos de li [options] | Lista de identificadores de contrato a los que el usuario tiene acceso. |
propiedades de lista | lp | Lista de propiedades asociadas con un ID de EdgeWorker determinado. |
| límites de lista | límites li | Vea los diversos límites que EdgeWorkers impone a la cantidad de activaciones, ID de EdgeWorkers y versiones que puede implementar. |
lista-restiers | li-restiers [options] | Enumere los niveles de recursos que se pueden usar para crear o clonar el ID de EdgeWorker. |
show-restier | show-restier | Los clientes pueden obtener detalles del nivel de recursos para un ID de EdgeWorker específico. |
| obtener informes | Obtenga una lista de todos los informes de EdgeWorkers disponibles. |
obtener informe | Obtenga un informe de EdgeWorkers para un ID de EdgeWorker específico. |
| lista de configuración | Obtenga todos los valores en el archivo de configuración. |
configuración obtener | Obtenga un valor de configuración de una sección del archivo de configuración. |
conjunto de configuración | Establezca un valor de configuración en una sección. |
guardar configuración -p | Guarde las propiedades de configuración en una sección. |
configuración desarmada | Desarmar un valor de configuración en una sección. |
El desarrollador del cliente puede encontrar su nivel de acceso de EdgeWorkers por grupo de control de acceso de Luna.
Uso: akamai edgeworkers list-groups [options] [group-identifier]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de grupo | opcional | Valor del grupo de acceso de Luna (generalmente un número) para verificar los permisos de EdgeWorkers |
La salida se filtra solo a aquellos grupos de control de acceso de Luna que tienen al menos una capacidad de EdgeWorkers.
Las capacidades pueden ser: VER, VER_VERSIÓN, EDITAR, VER_ACTIVACIÓN, CREAR_VERSIÓN, ACTIVAR
Enumere los ID de EdgeWorker actualmente registrados.
Uso: akamai edgeworkers list-ids [options] [edgeworker-identifier]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--groupId | Filtrar la lista de ID de EdgeWorker por grupo de permisos |
--resourceTierId | Filtrar ID de EdgeWorker por nivel de recursos |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | opcional | Un identificador entero único para una instancia de EdgeWorkers |
Registre una nueva identificación de EdgeWorker para hacer referencia en el comportamiento del Administrador de propiedades.
Uso: akamai edgeworkers register [options]
| Opción | Descripción |
|---|---|
| --resourceTierId | Nueva identificación del nivel de recurso al que se asociará EdgeWorker. |
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de grupo | requerido | Valor del grupo de acceso de Luna (generalmente un número) para verificar los permisos de EdgeWorkers |
| nombre-trabajador de borde | requerido | Etiqueta breve legible por humanos que describe una instancia de EdgeWorkers |
El encabezado de respuesta de ubicación se proporcionará con el nuevo ID de EdgeWorker.
El cuerpo de respuesta de los detalles de identificación de EdgeWorker (JSON) se proporcionará con el código de respuesta 201.
Para deshabilitar las solicitudes con fines de automatización, se puede proporcionar "resourceTierId" como entrada.
Permite al desarrollador del cliente actualizar los atributos Luna ACG o Nombre de un identificador EdgeWorker existente.
Uso: akamai edgeworkers update-id [options]
| Opción | Descripción |
|---|---|
| --resourceTierId | Nueva ID de nivel de recurso al que se asociará EdgeWorker |
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de grupo | requerido | Valor del grupo de acceso de Luna (generalmente un número) para verificar los permisos de EdgeWorkers |
| nombre-trabajador de borde | requerido | Etiqueta breve legible por humanos que describe una instancia de EdgeWorkers |
La API requiere que se proporcionen tanto el ID de grupo como el nombre incluso si solo se cambia uno de estos atributos.
El cuerpo de respuesta de los detalles de identificación de EdgeWorker (JSON) se proporcionará con un código de respuesta 200.
El ID de nivel de recurso proporcionado debe ser el mismo que el que ya tiene el ID de EdgeWorker. Para proporcionar una identificación de nivel de recurso diferente, utilice la operación de clonación.
Eliminar permanentemente un identificador de EdgeWorker existente.
Uso: akamai edgeworkers delete-id [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --noPreguntar | Omitir el mensaje de confirmación de eliminación |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
Solo es posible eliminar una ID de EdgeWorker si no tiene ninguna versión actualmente activa o en proceso de activación en la red Akamai.
Asegúrese de que no haya propiedades activas asociadas con un EdgeWorker antes de eliminarlo.
Enumere la información de la versión de un ID de EdgeWorker determinado.
Uso: akamai edgeworkers list-versions [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de versión | opcional | Un identificador entero único para la versión de una instancia de EdgeWorkers |
El conjunto de resultados se ordena por un valor de secuencia de carga que no se muestra (un entero incrementado interno).
Las versiones de EdgeWorker son cadenas definidas por el cliente.
Crea una nueva versión de un ID de EdgeWorker determinado que incluye el paquete de código.
Uso: akamai edgeworkers upload [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--bundle | Ruta al archivo del paquete en formato tgz |
--codeDir | Directorio de trabajo que incluye archivos main.js y bundle.json |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
Se debe proporcionar uno de los --bundle o --codeDir (pero no ambos).
Las rutas y los archivos de los paquetes de códigos se deben encontrar en el sistema de archivos local.
--bundle espera un archivo tgz ya creado según la especificación de EdgeWorkers.
--codeDir espera una ruta de directorio que contenga tanto main.js (archivo de eventos) como bundle.json (archivo de manifiesto).
La opción --codeDir proporcionará validación del formato bundle.json.
--codeDir no incluye otros directorios ni código más allá de main.js y bundle.json.
--codeDir creará el archivo tarball (tgz) si la validación del archivo se realiza correctamente.
El servicio comparará la suma de comprobación del nuevo archivo comprimido con los archivos comprimidos previamente cargados para el mismo ID de EdgeWorker ( ewId ). Si se encuentra una coincidencia, no se permite la creación de una nueva versión.
versionId lo genera el cliente y se extraerá de bundle.json.
El encabezado de respuesta de ubicación se proporcionará con la nueva identificación de la versión de EdgeWorker.
El cuerpo de respuesta de detalles de la versión de EdgeWorker (JSON) se proporcionará con el código de respuesta 201.
Eliminar permanentemente una versión existente de un ID de EdgeWorker determinado.
Uso: akamai edgeworkers delete-version [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --noPreguntar | Omitir el mensaje de confirmación de eliminación |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de versión | requerido | Un identificador entero único para la versión de una instancia de EdgeWorkers |
Solo es posible eliminar una versión si no está activa actualmente o no se está activando en la red Akamai.
Si la versión está actualmente activa, deberá desactivarse antes de poder eliminarla.
Descargue el paquete de códigos de una versión de EdgeWorker.
Uso: akamai edgeworkers download [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--descargaRuta | Ruta para almacenar el archivo del paquete descargado; El valor predeterminado es el directorio de inicio de CLI si no se proporciona. |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de versión | requerido | Un identificador entero único para la versión de una instancia de EdgeWorkers |
Si no se proporciona --downloadPath o no se encuentra en el sistema de archivos local, se utilizará un subdirectorio de caché AkamaiCLI:
Descargue el paquete de código combinado que contiene el código y las dependencias que ejecuta EdgeWorker.
Uso: akamai edgeworkers download-revision [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--descargaRuta | Ruta para almacenar el archivo del paquete combinado descargado; El valor predeterminado es el directorio de inicio de CLI si no se proporciona. |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Un identificador de revisión único para una instancia específica de EdgeWorkers |
Si no se proporciona --downloadPath o no se encuentra en el sistema de archivos local, se utilizará un subdirectorio de caché de AkamaiCLI:
Enumere el estado de activación de un ID de EdgeWorker determinado.
Uso: akamai edgeworkers status [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--versionId | Identificador de versión |
--activationId | Identificador de activación |
| --activoEnRed | Limita los resultados para mostrar solo las versiones activadas actualmente |
--red | Limita los resultados a versiones que se activaron en una red específica (STAGING o PRODUCTION) |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
No puede proporcionar los identificadores de Versión y Activación.
Enumere el historial de revisión de un ID de EdgeWorker determinado.
Uso: akamai edgeworkers list-revisions [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--versionId | Identificador de versión |
--activationId | Identificador de activación |
| --solo fijado | Limita los resultados para mostrar solo las revisiones fijadas actualmente o previamente |
| --actualmente fijado | Limita los resultados para mostrar solo las revisiones que están fijadas actualmente |
--red | Limita los resultados a versiones que se activaron en una red específica (STAGING o PRODUCTION) |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
La red debe ser ESCENARIO o PRODUCCIÓN. Las mayúsculas se normalizarán a mayúsculas.
Obtenga detalles para una revisión específica.
Uso: akamai edgeworkers get-revision [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Identificador de revisión |
Vea las diferencias de dependencia entre dos revisiones del mismo EdgeWorker.
Uso: akamai edgeworkers compare-revisions [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Identificador de primera revisión |
| identificador de revisión | requerido | Identificador de segunda revisión |
Ambos identificadores de revisión deben ser diferentes.
Active una revisión para un ID de EdgeWorker determinado en una red Akamai.
Uso: akamai edgeworkers activate-revision [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --nota | Nota para especificar por qué se reactiva la revisión |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Identificador de revisión |
La revisión se reactivará en la misma red (PRODUCCIÓN o STAGING) en la que estaba activa anteriormente.
Fije una revisión activa para una ID de EdgeWorker determinada.
Uso: akamai edgeworkers pin-revision [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --nota | Nota para especificar por qué se fija la revisión |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Identificador de revisión |
La revisión debe activarse antes de fijar.
Desanclar una revisión fijada activa para un ID de EdgeWorker determinado.
Uso: akamai edgeworkers unpin-revision [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --nota | Nota para especificar por qué se desancla la revisión |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Identificador de revisión |
La revisión debe fijarse antes de quitarla.
Ver detalles de una revisión específica de un paquete compuesto.
Uso: akamai edgeworkers get-revision-bom [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --versiones activas | Limite los resultados para mostrar solo las versiones activas |
| --revisiones actualmente fijadas | Muestra información adicional sobre la revisión actualmente fijada. |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| identificador de revisión | requerido | Identificador de revisión |
Listar el estado de activación de revisión de un ID de EdgeWorker determinado.
Uso: akamai edgeworkers list-revision-activations [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --ID de versión | Identificador de versión |
| --ID de activación | Identificador de activación |
| --red | Limita los resultados a versiones que se activaron en una red específica (STAGING o PRODUCTION) |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
No puede proporcionar los identificadores de Versión y Activación.
La red debe ser ESCENARIO o PRODUCCIÓN. Las mayúsculas se normalizarán a mayúsculas.
Active una versión para un ID de EdgeWorker determinado en una red Akamai.
Uso: akamai edgeworkers activate [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| red | requerido | Etiqueta a la que se debe enviar la activación de Akamai Network (STAGING o PRODUCTION) |
| identificador de versión | requerido | Un identificador entero único para la versión de una instancia de EdgeWorkers |
La red debe ser ESCENARIO o PRODUCCIÓN. Las mayúsculas se normalizarán a mayúsculas.
El encabezado de respuesta de ubicación se proporcionará con la nueva identificación de activación de EdgeWorker.
El cuerpo de respuesta de los detalles de activación de EdgeWorker (JSON) se proporcionará con el código de respuesta 201.
Valida una versión del paquete de códigos sin cargar el paquete de códigos.
Uso: akamai edgeworkers validate [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| ruta del paquete | requerido | Ruta al archivo del paquete en formato tgz |
La ruta del paquete de código se debe encontrar en el sistema de archivos local.
El paquete de código espera un archivo tgz ya creado según la especificación de EdgeWorkers.
Desactive una versión para un ID de EdgeWorker determinado en una red Akamai.
Uso: akamai edgeworkers deactivate [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Un identificador entero único para una instancia de EdgeWorkers |
| red | requerido | Etiqueta a la que se debe enviar la activación de Akamai Network (STAGING o PRODUCTION) |
| identificador de versión | requerido | Un identificador entero único para la versión de una instancia de EdgeWorkers |
La red debe ser ESCENARIO o PRODUCCIÓN. Las mayúsculas se normalizarán a mayúsculas.
El encabezado de respuesta de ubicación se proporcionará con la nueva identificación de activación de EdgeWorker.
El cuerpo de respuesta de los detalles de activación de EdgeWorker (JSON) se proporcionará con el código de respuesta 201.
Genera un token de autenticación que se puede utilizar para obtener encabezados de respuesta de depuración detallados de EdgeWorker. Necesita al menos la versión 1.7.1 de la CLI de EdgeWorkers para ejecutar este comando. Utilice la opción -V, --version para mostrar el número de versión actual de la CLI de EdgeWorkers.
Uso: akamai edgeworkers create-auth-token [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
--expiración | Duración de la caducidad del token, en minutos. |
--formato | Formato en el que se imprimirá la salida. |
| Argumento | Existencia | Descripción |
|---|---|---|
| nombre de host | opcional | Nombre de host de la propiedad. Si no se proporciona ningún nombre de host, se crea un token para todos los hosts ( /* ) en la propiedad. Por ejemplo: www.test.com, www.test1.com |
El valor --expiry debe estar entre 1 y 720 minutos (12 horas). El valor predeterminado es 8 hours .
Permite al cliente clonar un EdgeWorker a partir de una identificación de EdgeWorker existente.
Uso: akamai edgeworkers clone
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --ewNombre | Nombre del trabajador perimetral |
| --ID de grupo | Identificador de grupo |
| Argumento | Existencia | Descripción |
|---|---|---|
| ID de nivel de recurso | requerido | ID del nivel de recurso en el que se clonará EdgeWorker. |
Este punto final permite al usuario seleccionar una ID de nivel de recurso diferente para una identificación de EdgeWorker específica clonándola. La clonación al mismo nivel de recursos fallará.
Lista de identificadores de contrato a los que el usuario tiene acceso.
Uso: akamai list-contracts
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
Lista de propiedades asociadas a un ID de EdgeWorker específico.
Uso: akamai edgeworkers list-properties
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| --sólo activo | Devuelve sólo propiedades activas |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Identificador de EdgeWorker. |
Tenga en cuenta que el valor booleano devuelto LimitedAccessToProperties es verdadero si el usuario no tiene acceso al grupo de nivel superior de la cuenta o si no tiene la función de administrador para este grupo.
Enumere los diversos límites que EdgeWorkers impone a la cantidad de activaciones, ID de EdgeWorkers y versiones que puede implementar.
Uso: akamai edgeworkers list-limits [options]
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
Enumere los niveles de recursos que se pueden usar para crear o clonar ID de EdgeWorker.
Uso: akamai list-restiers
| Opción | Descripción |
|---|---|
| --identificador de contrato | Niveles de recursos para la identificación del contrato especificado. |
| -h, --ayuda | información de uso de salida |
Se le solicitará al usuario una lista de identificadores de contrato a los que tiene acceso. La identificación del contrato seleccionado se utilizará para recuperar el nivel de recursos.
Para deshabilitar el aviso con fines de automatización, se puede proporcionar la identificación del contrato como entrada.
Los clientes pueden obtener detalles del nivel de recursos para un ID de EdgeWorker específico.
Uso: akamai show-restier
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| ID de trabajador de borde | requerido | Identificador de trabajador perimetral |
Enumere los tipos de informes disponibles que se pueden generar para una ID de EdgeWorker.
Uso: akamai get reports
| Opción | Descripción |
|---|---|
| -h, --ayuda | información de uso de salida |
El usuario recibirá una tabla con los ID de los informes y una descripción de cada informe. Utilice un ID de informe determinado con el comando get report para obtener un informe para un EdgeWorker determinado.
Obtenga un informe para un ID de EdgeWorker determinado.
Uso: akamai get report
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
-s, --fechainicio | requerido | Marca de tiempo ISO 8601 que indica la hora de inicio del informe de EdgeWorkers. |
-e, --endDate | opcional | Marca de tiempo ISO 8601 que indica la hora de finalización del informe de EdgeWorkers. Si no se especifica, la hora de finalización predeterminada es la hora actual. |
--status | opcional | Cadena separada por comas para filtrar por estado de EdgeWorkers. Valores: success , genericError , unknownEdgeWorkerId , unimplementedEventHandler , runtimeError , executionError , timeoutError , resourceLimitHit , cpuTimeoutError , wallTimeoutError , initCpuTimeoutError , initWallTimeoutError . |
--ev, --eventHandlers | opcional | Cadena separada por comas para filtrar EdgeWorkers por el evento que los desencadena. Valores: onClientRequest , onOriginRequest , onOriginResponse , onClientResponse , responseProvider . |
| Argumento | Existencia | Descripción |
|---|---|---|
| ID de informe | requerido | Tipo de informe. |
| identificador de trabajador perimetral | requerido | Identificador de EdgeWorker. |
Para obtener una lista de ID de informes disponibles, utilice el comando get reports .
La opción startDate es una opción obligatoria.
Obtenga todas las propiedades predeterminadas en una sección del archivo de configuración.
Uso: akamai config list
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
La sección de configuración es default de forma predeterminada. Para utilizar una sección diferente, los usuarios deben especificar el comando akamai edgeworkers con la opción --configSection .
El mismo enfoque debería aplicarse a los siguientes comandos config .
Obtenga un valor predeterminado específico en una sección del archivo de configuración.
Uso: akamai config get
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| llave | requerido | Nombre de la propiedad predeterminada |
Permite a los clientes establecer/actualizar un valor predeterminado específico en una sección del archivo de configuración.
Uso: akamai config set
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| llave | requerido | Nombre de la propiedad predeterminada |
| valor | requerido | Valor de la propiedad predeterminada |
Permite a los clientes anular la configuración de un valor predeterminado específico en una sección del archivo de configuración.
Uso: akamai config unset
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| llave | requerido | Nombre de la propiedad predeterminada |
Permite a los clientes guardar los valores predeterminados de forma masiva.
Uso: akamai config save [options]
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
| -p, --propiedades | requerido | Propiedades de configuración. Utilice el formato 'clave=valor' para establecer una propiedad y espacios en blanco para dividirlos. |
Si el contexto contiene un elemento no válido, el comando omitirá ese elemento y continuará.
Permite a los clientes ver los detalles de las anulaciones de niveles de registro para el trabajador perimetral.
Uso: akamai edgeworkers log-level get [options]
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Identificador de EdgeWorker para mostrar información de anulación del nivel de registro. |
| identificador de registro | opcional | El ID de registro del nivel de registro anulado que se mostrará. |
Si no se especifica el logging-identifier , se mostrarán todas las anulaciones de niveles de registro.
El logging-identifier es una constante numérica que identifica una anulación de nivel de registro. Se puede obtener durante la creación de la anulación o enumerando todas las anulaciones sin proporcionar el argumento opcional y buscando el campo loggingId de la anulación específica.
Permite a los clientes establecer el nivel de registro para EdgeWorker.
Uso: akamai edgeworkers log-level set [options]
| Opción | Existencia | Descripción |
|---|---|---|
| -h, --ayuda | opcional | información de uso de salida |
| --expira | opcional | Especifica durante cuánto tiempo se aplicará la anulación del nivel de registro del usuario. Una vez transcurrido, el nivel de registro vuelve al valor predeterminado especificado en el paquete. |
| --ds2Id | opcional | ID de flujo de datos para usar junto con el especificado en el archivo bundle.json de EdgeWorker. |
| Argumento | Existencia | Descripción |
|---|---|---|
| identificador de trabajador perimetral | requerido | Identificador de EdgeWorker para el cual cambiar el nivel de registro. |
| red | requerido | Red para la cual aplicar el nuevo nivel de registro. Ya sea "producción" o "puesta en escena". |
| nivel | requerido | Nuevo nivel de registro para solicitar EdgeWorker. Para conocer los valores posibles, consulte la documentación de registro del cliente. |
Solo está vigente la anulación del nivel de registro creada más recientemente.
Cuando caduca la anulación, el nivel de registro se restablece al especificado en el archivo bundle.json de Edgeworker.
Si el comando se ejecuta correctamente, se imprimen los detalles de la anulación del nivel de registro, que incluyen loggingId de la anulación. El loggingId se puede utilizar para obtener estos detalles en cualquier momento utilizando el subcomando log-level get y pasándolo a un argumento opcional logging-identifier .
Si no se especifica la opción --expires , el valor predeterminado es que la anulación nunca caduque.
La opción --expires admite tanto la entrada en lenguaje natural como las marcas de tiempo estándar. Consulte la documentación del paquete chrono para conocer las especificaciones completas.
Establezca la anulación del nivel de registro en la red de producción al nivel de información, que caducará en 1 hora.
./akamai-edgeworkers log-level set 654321 production info --expires 1h
Establezca la anulación del nivel de registro en la red provisional al nivel de seguimiento, que caducará a las 3 p.m. CEST (hora de verano de Europa Central) el 13 de agosto de 2024.
./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"
Para obtener más información sobre EdgeWorkers, consulte los siguientes recursos:
Página de desarrollador de EdgeWorkers
Guía del usuario de EdgeWorkers
Guía de API de EdgeWorkers
Ya está todo listo, ¡feliz codificación! Si tiene algún problema con la CLI de EdgeWorkers, menciónelo como un problema de github. No dudes en crear una solicitud de extracción con la solución o sugerencia.
Agradecemos las contribuciones del personal de Akamai, de los clientes u otros. Antes de abrir un PR, verifique lo siguiente:
Agregue algunos casos de prueba para acompañar su PR. Esto verifica la funcionalidad agregada o modificada en el PR y demuestra a otros que su código funciona :)
Asegúrese de que su código pase todas las comprobaciones previas a la confirmación. Su código debería compilarse correctamente, pasar todas las pruebas unitarias y no tener problemas de linting.
Todos los RP deberían apuntar a desarrollar, no a dominar. Las fusiones con master se publicarán inmediatamente para todos los clientes.
