CLI do EdgeWorkers A interface de linha de comando (CLI) do EdgeWorkers agiliza o processo de registro, upload, ativação e teste de funções do EdgeWorkers na rede Akamai Edge.
Acesse Akamai CLI para EdgeKV para obter informações sobre como gerenciar bancos de dados EdgeKV e chamar a API EdgeKV na linha de comando.
Para usar esta ferramenta você precisa:
CLI da Akamai instalada.
Se você não possui a CLI e está usando o Homebrew em um Mac, execute este comando: brew install akamai
Você também pode baixar binários CLI específicos do sistema operacional ou uma imagem Docker
Credenciais válidas do EdgeGrid configuradas por meio do Akamai Control Center (consulte Introdução às APIs)
Versão do nó 14 ou superior
Se você não tiver o pacote EdgeWorkers CLI instalado, use o seguinte comando Akamai CLI para instalar o pacote EdgeWorkers CLI mais recente:
Uso:
akamai install edgeworkers
Se você já tiver a CLI instalada, use o seguinte comando da CLI da Akamai para instalar o pacote CLI do EdgeWorkers mais recente que inclui a funcionalidade do EdgeKV:
Uso:
akamai update edgeworkers
A CLI do EdgeWorkers permite definir valores padrão para as opções de comando. Existem duas maneiras de criar um arquivo de configuração:
Crie um arquivo de configuração ~/.akamai-cli/ew-config e armazene as propriedades da seguinte forma:
[padrão] edgeworkerName = testeEW ID do grupo=12345 ID da versão = 1-0-2
Use o comando config para definir propriedades padrão: akamai edgeworkers config set
Os nomes de propriedades disponíveis são exibidos aqui.
EdgeWorkers CLI permite gerenciar funções EdgeWorkers chamando a API EdgeWorkers.
Convenções:
argumentos opcionais []
argumentos obrigatórios <>
Uso:
akamai edgeworkers [options] [command]
Opções:
| Sintaxe | Descrição |
|---|---|
| -V, --versão | Exiba o número da versão do programa EdgeWorkers CLI. |
| --depurar | Mostrar informações de depuração. |
--edgerc | Use credenciais no arquivo edgerc para comando. (O local padrão do arquivo é ~/.edgerc ) |
--seção | Use esta seção no arquivo edgerc . (A seção padrão é [default] ) |
--configSection | Use esta seção no arquivo ew-config que contém o conjunto de propriedades de configuração padrão. (A seção padrão é [default] ) |
--timeout | Você pode especificar um valor de tempo limite para um comando em segundos para substituir o padrão de 2 minutos. Por exemplo, se você adicionar "--timeout 10" a um comando, o tempo limite será atingido se o servidor demorar mais de 10 segundos para responder. |
--json [path] | Grave a saída da CLI como JSON no caminho fornecido opcionalmente. Se o caminho não for fornecido, grave a saída JSON no diretório inicial da CLI |
| --jsonout | Escreva a saída CLI como JSON para stdout. |
| -h, --ajuda | Exibir informações de uso para EdgeWorkers CLI. |
Comandos:
| Comando | Alias | Descrição |
|---|---|
ajuda [command] | Exibir informações de uso para o comando fornecido. |
grupos de listas | lg [group-identifier] | O desenvolvedor do cliente pode encontrar seu nível de acesso EdgeWorkers por grupo de controle de acesso Luna. |
lista-ids | li [options] [edgeworker-identifier] | Lista os IDs do EdgeWorker atualmente registrados. |
registrar | create-id | Registre um novo ID do EdgeWorker para referência no comportamento do Property Manager. |
id de atualização | ui | Permite que o Customer Developer atualize os atributos Luna ACG ou Name de um identificador EdgeWorker existente. |
excluir-id | delete-id [options] | Exclua permanentemente um ID do EdgeWorker existente. |
versões de lista | lv | Lista informações de versão de um determinado ID do EdgeWorker. |
carregar | criar versão [options] | Cria uma nova versão de um determinado ID do EdgeWorker que inclui o pacote de código. |
excluir versão | delete-version [options] | Exclua permanentemente uma versão existente de um determinado ID do EdgeWorker. |
baixar | versão de download [options] | Baixe o pacote de códigos de uma versão do EdgeWorker. |
revisão de download | dr [options] | Baixe o pacote de código combinado que contém o código e as dependências que o EdgeWorker executa. |
estado | ativações de lista [options] | Lista o status de ativação de um determinado ID do EdgeWorker. |
revisões de listas | lr [options] | Liste o histórico de revisões para um determinado ID do EdgeWorker. |
obter revisão | gr | Obtenha detalhes de uma revisão específica. |
comparar revisões | cr | Veja as diferenças de dependência entre duas revisões do mesmo EdgeWorker. |
ativar-revisão | ar [options] | Ative uma revisão para um determinado ID do EdgeWorker na Akamai Network. |
revisão de pinos [options] | Fixe uma revisão ativa para um determinado ID do EdgeWorker. |
desafixar revisão [options] | Desafixe uma revisão fixada ativa para um determinado ID do EdgeWorker. |
obter-revisão-bom | gb [options] | Visualize detalhes de uma revisão específica de um pacote configurável composto. |
ativações de revisão de lista | lra [options] | Listar o status de ativação da revisão de um determinado ID do EdgeWorker. |
ativar | av | Ative uma versão para um determinado ID do EdgeWorker em uma rede Akamai. |
desativar | deact | Desative uma versão para um determinado ID do EdgeWorker em uma rede Akamai. |
validar | vv | Valida uma versão do pacote de códigos sem fazer upload do pacote de códigos. |
criar-token de autenticação | autenticação [options] | Gera um token de autenticação que pode ser usado para obter cabeçalhos detalhados de resposta de depuração do EdgeWorker. Você precisa de pelo menos a versão 1.7.1 do EdgeWorkers CLI para executar este comando. |
clonar | clone | Clona um EdgeWorker do ID do EdgeWorker existente. |
lista-contratos | contratos li [options] | Lista de IDs de contrato aos quais o usuário tem acesso. |
propriedades de lista | lp | Lista de propriedades associadas a um determinado ID do EdgeWorker. |
| limites de lista | li-limites | Veja os vários limites que o EdgeWorkers impõe ao número de ativações, IDs do EdgeWorkers e versões que você pode implantar. |
lista-restiers | li-restiers [options] | Listar camadas de recursos que podem ser usadas para criar ou clonar ID do EdgeWorker. |
show-restier | show-restier | Os clientes podem obter detalhes do Resource Tier para um ID específico do EdgeWorker. |
| obter relatórios | Obtenha uma lista de todos os relatórios EdgeWorkers disponíveis. |
obter relatório | Obtenha um relatório EdgeWorkers para um ID EdgeWorker específico. |
| lista de configurações | Obtenha todos os valores no arquivo de configuração. |
configuração obter | Obtenha um valor de configuração de uma seção no arquivo de configuração. |
conjunto de configurações | Defina um valor de configuração em uma seção. |
configuração salvar -p | Salve as propriedades de configuração em uma seção. |
configuração não definida | Desmarque um valor de configuração em uma seção. |
O desenvolvedor do cliente pode encontrar seu nível de acesso EdgeWorkers por grupo de controle de acesso Luna.
Uso: akamai edgeworkers list-groups [options] [group-identifier]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador de grupo | opcional | Valor do Luna Access Group (geralmente número) para verificar as permissões do EdgeWorkers |
A saída é filtrada apenas para os grupos de controle de acesso Luna que possuem pelo menos um recurso EdgeWorkers.
Os recursos podem ser: VIEW,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE
Lista os IDs do EdgeWorker atualmente registrados.
Uso: akamai edgeworkers list-ids [options] [edgeworker-identifier]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--groupId | Filtrar lista de IDs do EdgeWorker por grupo de permissões |
--resourceTierId | Filtrar ID do EdgeWorker por camada de recurso |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | opcional | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
Registre um novo ID do EdgeWorker para referência no comportamento do Property Manager.
Uso: akamai edgeworkers register [options]
| Opção | Descrição |
|---|---|
| --resourceTierId | Novo ID da camada de recursos ao qual o EdgeWorker será associado. |
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador de grupo | obrigatório | Valor do Luna Access Group (geralmente número) para verificar as permissões do EdgeWorkers |
| nome do edgeworker | obrigatório | Rótulo curto legível descrevendo uma instância do EdgeWorkers |
O cabeçalho de resposta de localização será fornecido com o novo ID do EdgeWorker.
O corpo de resposta dos detalhes do ID do EdgeWorker (JSON) será fornecido com o código de resposta 201.
Para desabilitar prompts para fins de automação, "resourceTierId" pode ser fornecido como entrada.
Permite que o Customer Developer atualize os atributos Luna ACG ou Name de um identificador EdgeWorker existente.
Uso: akamai edgeworkers update-id [options]
| Opção | Descrição |
|---|---|
| --resourceTierId | Novo ID da camada de recurso ao qual o EdgeWorker será associado |
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de grupo | obrigatório | Valor do Luna Access Group (geralmente número) para verificar as permissões do EdgeWorkers |
| nome do edgeworker | obrigatório | Rótulo curto legível descrevendo uma instância do EdgeWorkers |
A API exige que groupId e name sejam fornecidos, mesmo que altere apenas um desses atributos.
O corpo de resposta dos detalhes do ID do EdgeWorker (JSON) será fornecido com 200 códigos de resposta.
O ID do nível de recurso fornecido deve ser o mesmo que o ID do EdgeWorker já possui. Para fornecer um ID de nível de recurso diferente, use a operação de clone.
Exclua permanentemente um identificador EdgeWorker existente.
Uso: akamai edgeworkers delete-id [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --noPrompt | Ignore o prompt de confirmação de exclusão |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
A exclusão de um ID do EdgeWorker só é possível se ele não tiver nenhuma versão atualmente ativa ou em ativação na rede Akamai.
Certifique-se de que não haja propriedades ativas associadas a um EdgeWorker antes da exclusão.
Lista informações de versão de um determinado ID do EdgeWorker.
Uso: akamai edgeworkers list-versions [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de versão | opcional | Um identificador inteiro exclusivo para a versão de uma instância do EdgeWorkers |
O conjunto de resultados é classificado por um valor de sequência de upload que não é exibido (um número inteiro incrementado interno).
As versões do EdgeWorker são strings definidas pelo cliente.
Cria uma nova versão de um determinado ID do EdgeWorker que inclui o pacote de código.
Uso: akamai edgeworkers upload [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--bundle | Caminho para agrupar o arquivo no formato tgz |
--codeDir | Diretório de trabalho que inclui arquivos main.js e bundle.json |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
Um dos --bundle ou --codeDir (mas não ambos) deve ser fornecido.
Os caminhos e arquivos dos pacotes de código devem ser encontrados no sistema de arquivos local.
--bundle espera um arquivo tgz já construído de acordo com a especificação EdgeWorkers.
--codeDir espera um caminho de diretório que contém main.js (arquivo de eventos) e bundle.json (arquivo de manifesto).
A opção --codeDir fornecerá validação do formato bundle.json.
--codeDir não empacota outros diretórios ou códigos além de main.js e bundle.json.
--codeDir criará o arquivo tarball (tgz) se a validação do arquivo for bem-sucedida.
O serviço comparará a soma de verificação do novo tarball com os tarballs carregados anteriormente para o mesmo ID do EdgeWorker ( ewId ). Se uma correspondência for encontrada, a criação da nova versão não será permitida.
versionId é gerado pelo cliente e será extraído de bundle.json.
O cabeçalho de resposta de localização será fornecido com o novo ID da versão do EdgeWorker.
O corpo da resposta (JSON) dos detalhes da versão do EdgeWorker será fornecido com o código de resposta 201.
Exclua permanentemente uma versão existente de um determinado ID do EdgeWorker.
Uso: akamai edgeworkers delete-version [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --noPrompt | Ignore o prompt de confirmação de exclusão |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de versão | obrigatório | Um identificador inteiro exclusivo para a versão de uma instância do EdgeWorkers |
A exclusão de uma versão só é possível se ela não estiver ativa ou ativada na rede Akamai.
Se a versão estiver ativa no momento, ela deverá ser desativada antes de poder ser excluída.
Baixe o pacote de códigos de uma versão do EdgeWorker.
Uso: akamai edgeworkers download [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--downloadPath | Caminho para armazenar o arquivo do pacote baixado; o padrão é o diretório inicial da CLI, se não for fornecido. |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de versão | obrigatório | Um identificador inteiro exclusivo para a versão de uma instância do EdgeWorkers |
Se --downloadPath não for fornecido ou não for encontrado no sistema de arquivos local, um subdiretório de cache AkamaiCLI será usado:
Baixe o pacote de código combinado que contém o código e as dependências que o EdgeWorker executa.
Uso: akamai edgeworkers download-revision [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--downloadPath | Caminho para armazenar o arquivo do pacote combinado baixado; o padrão é o diretório inicial da CLI, se não for fornecido. |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Um identificador de revisão exclusivo para uma instância específica do EdgeWorkers |
Se --downloadPath não for fornecido ou não for encontrado no sistema de arquivos local, um subdiretório de cache AkamaiCLI será usado:
Lista o status de ativação de um determinado ID do EdgeWorker.
Uso: akamai edgeworkers status [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--versionId | Identificador de versão |
--activationId | Identificador de ativação |
| --activeOnNetwork | Limita os resultados para mostrar apenas as versões atualmente ativadas |
--rede | Limita os resultados às versões que foram ativadas em uma rede específica (STAGING ou PRODUCTION) |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
Você não pode fornecer os identificadores de versão e de ativação.
Liste o histórico de revisões para um determinado ID do EdgeWorker.
Uso: akamai edgeworkers list-revisions [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--versionId | Identificador de versão |
--activationId | Identificador de ativação |
| --pinnedOnly | Limita os resultados para mostrar apenas as revisões fixadas atualmente ou anteriormente |
| --atualmentePinned | Limita os resultados para mostrar apenas as revisões que estão fixadas no momento |
--rede | Limita os resultados às versões que foram ativadas em uma rede específica (STAGING ou PRODUCTION) |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
A rede deve ser STAGING ou PRODUCTION. A capitalização será normalizada para maiúsculas.
Obtenha detalhes de uma revisão específica.
Uso: akamai edgeworkers get-revision [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Identificador de revisão |
Veja as diferenças de dependência entre duas revisões do mesmo EdgeWorker.
Uso: akamai edgeworkers compare-revisions [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Identificador da primeira revisão |
| identificador de revisão | obrigatório | Identificador da segunda revisão |
Ambos os identificadores de revisão devem ser diferentes.
Ative uma revisão para um determinado ID do EdgeWorker em uma rede Akamai.
Uso: akamai edgeworkers activate-revision [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --observação | Nota para especificar por que a revisão está sendo reativada |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Identificador de revisão |
A revisão será reativada na mesma rede (PRODUÇÃO ou STAGING) em que estava ativa anteriormente.
Fixe uma revisão ativa para um determinado ID do EdgeWorker.
Uso: akamai edgeworkers pin-revision [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --observação | Nota para especificar por que a revisão está sendo fixada |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Identificador de revisão |
A revisão deve ser ativada antes da fixação.
Desafixe uma revisão fixada ativa para um determinado ID do EdgeWorker.
Uso: akamai edgeworkers unpin-revision [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --observação | Nota para especificar por que a revisão está sendo desafixada |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Identificador de revisão |
A revisão deve ser fixada antes de ser liberada.
Visualize detalhes de uma revisão específica de um pacote configurável composto.
Uso: akamai edgeworkers get-revision-bom [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --activeVersions | Limite os resultados para mostrar apenas versões ativas |
| --atualmentePinnedRevisions | Mostra informações adicionais sobre a revisão que está fixada no momento |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| identificador de revisão | obrigatório | Identificador de revisão |
Listar o status de ativação da revisão de um determinado ID do EdgeWorker.
Uso: akamai edgeworkers list-revision-activations [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --versionId | Identificador de versão |
| --activationId | Identificador de ativação |
| --rede | Limita os resultados às versões que foram ativadas em uma rede específica (STAGING ou PRODUCTION) |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
Você não pode fornecer os identificadores de versão e de ativação.
A rede deve ser STAGING ou PRODUCTION. A capitalização será normalizada para maiúsculas.
Ative uma versão para um determinado ID do EdgeWorker em uma rede Akamai.
Uso: akamai edgeworkers activate [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| rede | obrigatório | Rótulo para o qual a ativação da Akamai Network (STAGING ou PRODUCTION) deve ser enviada para |
| identificador de versão | obrigatório | Um identificador inteiro exclusivo para a versão de uma instância do EdgeWorkers |
A rede deve ser STAGING ou PRODUCTION. A capitalização será normalizada para maiúsculas.
O cabeçalho de resposta de localização será fornecido com o novo ID de ativação do EdgeWorker.
O corpo de resposta (JSON) dos detalhes de ativação do EdgeWorker será fornecido com o código de resposta 201.
Valida uma versão do pacote de códigos sem fazer upload do pacote de códigos
Uso: akamai edgeworkers validate [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| pacotePath | obrigatório | Caminho para agrupar o arquivo no formato tgz |
O caminho do pacote de código deve ser encontrado no sistema de arquivos local.
O pacote de código espera um arquivo tgz já construído de acordo com a especificação EdgeWorkers.
Desative uma versão para um determinado ID do EdgeWorker em uma rede Akamai.
Uso: akamai edgeworkers deactivate [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Um identificador inteiro exclusivo para uma instância do EdgeWorkers |
| rede | obrigatório | Rótulo para o qual a ativação da Akamai Network (STAGING ou PRODUCTION) deve ser enviada para |
| identificador de versão | obrigatório | Um identificador inteiro exclusivo para a versão de uma instância do EdgeWorkers |
A rede deve ser STAGING ou PRODUCTION. A capitalização será normalizada para maiúsculas.
O cabeçalho de resposta de localização será fornecido com o novo ID de ativação do EdgeWorker.
O corpo de resposta (JSON) dos detalhes de ativação do EdgeWorker será fornecido com o código de resposta 201.
Gera um token de autenticação que pode ser usado para obter cabeçalhos detalhados de resposta de depuração do EdgeWorker. Você precisa de pelo menos a versão 1.7.1 do EdgeWorkers CLI para executar este comando. Use a opção -V, --version para exibir o número da versão atual do EdgeWorkers CLI.
Uso: akamai edgeworkers create-auth-token [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
--expiração | Duração da expiração do token, em minutos. |
--format | Formato em que a saída será impressa |
| Argumento | Existência | Descrição |
|---|---|---|
| nome do host | opcional | HostName da propriedade. Se nenhum nome de host for fornecido, o token será criado para todos os hosts ( /* ) na propriedade. Por exemplo: www.test.com, www.test1.com |
O valor --expiry deve estar entre 1 e 720 minutos (12 horas). O padrão é 8 hours .
Permite que o cliente clone um EdgeWorker de um ID de EdgeWorker existente.
Uso: akamai edgeworkers clone
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --ewNome | Nome do EdgeWorker |
| --groupId | Identificador de grupo |
| Argumento | Existência | Descrição |
|---|---|---|
| recursoTierId | obrigatório | ID da camada de recursos para a qual o EdgeWorker será clonado. |
Este endpoint permite que o usuário selecione um ID de nível de recurso diferente para um ID específico do EdgeWorker clonando-o. A clonagem para a mesma camada de recursos falhará.
Lista de IDs de contrato aos quais o usuário tem acesso.
Uso: akamai list-contracts
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
Lista de propriedades associadas a um ID EdgeWorker específico.
Uso: akamai edgeworkers list-properties
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| --activeOnly | Retorna apenas propriedades ativas |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Identificador EdgeWorker. |
Observe que o booleano limitAccessToProperties retornado será verdadeiro se o usuário não tiver acesso ao grupo de nível superior da conta ou se não tiver a função de administrador desse grupo.
Liste os vários limites que o EdgeWorkers impõe ao número de ativações, IDs do EdgeWorkers e versões que você pode implantar.
Uso: akamai edgeworkers list-limits [options]
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
Listar camadas de recursos que podem ser usadas para criar ou clonar IDs do EdgeWorker.
Uso: akamai list-restiers
| Opção | Descrição |
|---|---|
| --contractId | Camadas de recursos para o ID do contrato especificado. |
| -h, --ajuda | informações de uso de saída |
O usuário receberá uma lista de IDs de contrato aos quais o usuário tem acesso. O ID do contrato selecionado será usado para buscar a camada de recursos.
Para desabilitar o prompt para fins de automação, o ID do contrato pode ser fornecido como entrada.
Os clientes podem obter detalhes do Resource Tier para um ID específico do EdgeWorker.
Uso: akamai show-restier
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| edgeworkerID | obrigatório | Identificador EdgeWorker |
Liste os tipos de relatórios disponíveis que podem ser gerados para um ID do EdgeWorker.
Uso: akamai get reports
| Opção | Descrição |
|---|---|
| -h, --ajuda | informações de uso de saída |
O usuário receberá uma tabela com reportIds e uma descrição de cada relatório. Use um determinado reportId com o comando get report para obter um relatório para um determinado EdgeWorker.
Obtenha um relatório para um determinado ID do EdgeWorker.
Uso: akamai get report
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
-s, --startDate | obrigatório | Carimbo de data/hora ISO 8601 indicando a hora de início do relatório EdgeWorkers. |
-e, --endDate | opcional | Carimbo de data/hora ISO 8601 indicando o horário de término do relatório EdgeWorkers. Se não for especificado, o horário de término será padronizado como o horário atual. |
--status | opcional | String separada por vírgula para filtrar por status de EdgeWorkers. Valores: success , genericError , unknownEdgeWorkerId , unimplementedEventHandler , runtimeError , executionError , timeoutError , resourceLimitHit , cpuTimeoutError , wallTimeoutError , initCpuTimeoutError , initWallTimeoutError . |
--ev, --eventHandlers | opcional | String separada por vírgula para filtrar EdgeWorkers pelo evento que os aciona. Valores: onClientRequest , onOriginRequest , onOriginResponse , onClientResponse , responseProvider . |
| Argumento | Existência | Descrição |
|---|---|---|
| ID do relatório | obrigatório | Tipo de relatório. |
| identificador do edgeworker | obrigatório | Identificador EdgeWorker. |
Para obter uma lista de IDs de relatórios disponíveis, use o comando get reports .
A opção startDate é uma opção obrigatória.
Obtenha todas as propriedades padrão em uma seção do arquivo de configuração.
Uso: akamai config list
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
A seção de configuração é default por padrão. Para usar uma seção diferente, os usuários devem especificar o comando akamai edgeworkers com a opção --configSection .
A mesma abordagem deve ser aplicada aos seguintes comandos config .
Obtenha um valor padrão específico em uma seção do arquivo de configuração.
Uso: akamai config get
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| chave | obrigatório | Nome da propriedade padrão |
Permite que os clientes definam/atualizem um valor padrão específico em uma seção do arquivo de configuração.
Uso: akamai config set
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| chave | obrigatório | Nome da propriedade padrão |
| valor | obrigatório | Valor da propriedade padrão |
Permite que os clientes desmarquem um valor padrão específico em uma seção do arquivo de configuração.
Uso: akamai config unset
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| chave | obrigatório | Nome da propriedade padrão |
Permite que os clientes salvem os valores padrão em massa.
Uso: akamai config save [options]
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
| -p, --propriedades | obrigatório | Propriedades de configuração. Use o formato 'key=value' para definir uma propriedade e um espaço em branco para dividi-las. |
Se o contexto contiver um item inválido, o comando irá ignorar esse item e continuar.
Permite que os clientes visualizem os detalhes das substituições de nível de registro para o edgeworker.
Uso: akamai edgeworkers log-level get [options]
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Identificador do EdgeWorker para o qual exibir informações de substituição de nível de log. |
| identificador de registro | opcional | O ID de registro da substituição do nível de registro a ser exibido. |
Se o logging-identifier não for especificado, todas as substituições de nível de registro serão exibidas.
O logging-identifier é uma constante numérica que identifica uma substituição no nível de log. Ele pode ser obtido durante a criação da substituição ou listando todas as substituições sem fornecer o argumento opcional e consultando o campo loggingId da substituição específica.
Permite que os clientes definam o nível de log para o EdgeWorker.
Uso: akamai edgeworkers log-level set [options]
| Opção | Existência | Descrição |
|---|---|---|
| -h, --ajuda | opcional | informações de uso de saída |
| --expira | opcional | Especifica por quanto tempo a substituição do nível de registro do usuário será aplicada. Após a aprovação, o nível de criação de log volta ao padrão especificado no pacote configurável. |
| --ds2Id | opcional | ID do Datastream a ser usado junto com aquele especificado no arquivo bundle.json do EdgeWorker. |
| Argumento | Existência | Descrição |
|---|---|---|
| identificador do edgeworker | obrigatório | Identificador do EdgeWorker para o qual alterar o nível de log. |
| rede | obrigatório | Rede à qual aplicar o novo nível de registro em log. Ou "produção" ou "encenação". |
| nível | obrigatório | Novo nível de registro a ser aplicado ao EdgeWorker. Para valores possíveis consulte a documentação de registro do cliente. |
Somente a substituição de nível de log criada mais recentemente está em vigor.
Quando a substituição expira, o nível de log é redefinido para aquele especificado no arquivo bundle.json do Edgeworker.
Se o comando for bem-sucedido, os detalhes da substituição no nível do log serão impressos, incluindo loggingId da substituição. O loggingId pode ser usado para obter esses detalhes a qualquer momento usando o subcomando log-level get e passando-o para um argumento opcional logging-identifier .
Se a opção --expires não for especificada, o padrão é que a substituição nunca expire.
A opção --expires suporta entrada de linguagem natural e carimbos de data/hora padrão. Consulte a documentação do pacote chrono para especificações completas.
Defina a substituição do nível de log na rede de produção para o nível de informação, que expirará em 1 hora.
./akamai-edgeworkers log-level set 654321 production info --expires 1h
Defina a substituição do nível de log na rede de teste para o nível de rastreamento, que expirará às 15h CEST (horário de verão da Europa Central) em 13 de agosto de 2024.
./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"
Para obter mais informações sobre EdgeWorkers, consulte os seguintes recursos:
Página do desenvolvedor EdgeWorkers
Guia do usuário EdgeWorkers
Guia da API EdgeWorkers
Está tudo pronto, boa codificação! Se você tiver algum problema com a CLI do EdgeWorkers, levante-o como um problema do github. Sinta-se à vontade para criar uma solicitação pull com a correção ou sugestão.
Aceitamos contribuições de funcionários, clientes ou outros da Akamai. Antes de abrir um PR, verifique o seguinte:
Adicione alguns casos de teste para acompanhar seu PR. Isso verifica a funcionalidade adicionada ou modificada no PR e prova aos outros que seu código funciona :)
Certifique-se de que seu código passe em todas as verificações de pré-confirmação. Seu código deve ser compilado com sucesso, passar em todos os testes de unidade e não ter problemas de linting.
Todos os PRs devem ter como objetivo o desenvolvimento, não o domínio. As mesclagens para master serão liberadas imediatamente para todos os clientes.
