EdgeWorkers CLI EdgeWorkers 命令行界面 (CLI) 加快了在 Akamai Edge 网络上注册、上传、激活和测试 EdgeWorkers 功能的过程。
请访问 Akamai CLI for EdgeKV,了解有关如何管理 EdgeKV 数据库以及从命令行调用 EdgeKV API 的信息。
要使用此工具,您需要:
Akamai CLI 已安装。
如果您没有 CLI 并且在 Mac 上使用 Homebrew,请运行以下命令: brew install akamai
您还可以下载特定于操作系统的 CLI 二进制文件或 Docker 映像
通过 Akamai Control Center 配置的有效 EdgeGrid 凭据(请参阅 API 入门)
节点版本 14 或更高版本
如果您尚未安装 EdgeWorkers CLI 软件包,请使用以下 Akamai CLI 命令安装最新的 EdgeWorkers CLI 软件包:
用法:
akamai install edgeworkers
如果您已安装 CLI,请使用以下 Akamai CLI 命令安装包含 EdgeKV 功能的最新 EdgeWorkers CLI 软件包:
用法:
akamai update edgeworkers
EdgeWorkers CLI 允许您设置命令选项的默认值。创建配置文件有两种方法:
创建配置文件~/.akamai-cli/ew-config
,并存储属性,如下所示:
[默认] EdgeworkerName=testEW 组ID=12345 版本ID=1-0-2
使用config
命令设置默认属性: akamai edgeworkers config set
此处显示可用的属性名称。
EdgeWorkers CLI 使您能够通过调用 EdgeWorkers API 来管理 EdgeWorkers 功能。
约定:
可选参数[]
必需的参数<>
用法:
akamai edgeworkers [options] [command]
选项:
句法 | 描述 |
---|---|
-V,--版本 | 显示 EdgeWorkers CLI 程序的版本号。 |
- 调试 | 显示调试信息。 |
--edgerc
| 使用edgerc 文件中的凭据来执行命令。 (默认文件位置是~/.edgerc ) |
--section
| 在edgerc 文件中使用此部分。 (默认部分是[default] ) |
--configSection
| 使用包含默认配置属性集的ew-config 文件中的此部分。 (默认部分是[default] ) |
--超时
| 您可以指定命令的超时值(以秒为单位)以覆盖 2 分钟的默认值。例如,如果在命令中添加“--timeout 10”,则如果服务器响应时间超过 10 秒,命令就会超时。 |
--json [path] | 将 CLI 输出以 JSON 形式写入可选提供的路径。 如果未提供路径,则将 JSON 输出写入 CLI 主目录 |
--jsonout | 将 CLI 输出作为 JSON 写入标准输出。 |
-h,--帮助 | 显示 EdgeWorkers CLI 的使用信息。 |
命令:
命令 |别名 | 描述 |
---|---|
帮助[command] | 显示给定命令的使用信息。 |
列表组 | lg [group-identifier] | 客户开发人员可以根据 Luna 访问控制组找到其 EdgeWorkers 访问级别。 |
列表 ID | li [options] [edgeworker-identifier] | 列出当前注册的 EdgeWorker ID。 |
注册 | create-id
| 注册一个新的 EdgeWorker ID 以在 Property Manager 行为中引用。 |
更新 ID | ui
| 允许客户开发人员更新现有 EdgeWorker 标识符的 Luna ACG 或名称属性。 |
删除 ID |删除 id [options] | 永久删除现有的 EdgeWorker ID。 |
列表版本 | lv
| 列出给定 EdgeWorker Id 的版本信息。 |
上传 |创建版本[options] | 创建给定 EdgeWorker Id 的新版本,其中包括代码包。 |
删除版本 |删除版本[options] | 永久删除给定 EdgeWorker Id 的现有版本。 |
下载 |下载版本[options] | 下载EdgeWorker版本的代码包。 |
下载修订| dr [options] | 下载包含 EdgeWorker 执行的代码和依赖项的组合代码包。 |
状态 |列表激活[options] | 列出给定 EdgeWorker Id 的激活状态。 |
列表修订| lr [options] | 列出给定 EdgeWorker ID 的修订历史记录。 |
获取修订| gr
| 获取特定修订的详细信息。 |
比较修订| cr
| 查看同一 EdgeWorker 的两个修订版之间的依赖性差异。 |
激活修订 | ar [options] | 在 Akamai 网络上激活给定 EdgeWorker Id 的修订版。 |
pin-revision [options] | 固定给定 EdgeWorker ID 的活动修订版。 |
unpin-revision [options] | 取消固定给定 EdgeWorker ID 的活动固定修订版本。 |
获取修订 Bom | gb [options] | 查看复合捆绑包特定修订版的详细信息。 |
列表修订激活 | lra [options] | 列出给定 EdgeWorker ID 的修订激活状态。 |
激活| av
| 在 Akamai 网络上激活给定 EdgeWorker ID 的版本。 |
停用 | deact
| 停用 Akamai 网络上给定 EdgeWorker ID 的版本。 |
验证 | vv
| 验证代码包版本而不上传代码包。 |
创建身份验证令牌 | auth [options] | 生成可用于获取详细 EdgeWorker 调试响应标头的身份验证令牌。您至少需要 EdgeWorkers CLI 版本 1.7.1 才能运行此命令。 |
克隆|克隆
| 从现有 EdgeWorker ID 克隆 EdgeWorker。 |
合同清单 | li-合同[options] | 用户有权访问的合约 ID 列表。 |
列表属性 | lp
| 与给定 EdgeWorker Id 关联的属性列表。 |
列表限制 |限制 | 查看 EdgeWorkers 对激活数量、EdgeWorkers ID 和您可以部署的版本施加的各种限制。 |
列表-restiers | li-restiers [options] | 列出可用于创建或克隆 EdgeWorker Id 的资源层。 |
表演-restier | show-restier
| 客户可以获得特定 EdgeWorker ID 的资源层详细信息。 |
获取报告 | 获取所有可用 EdgeWorkers 报告的列表。 |
获取报告
| 获取特定 EdgeWorker ID 的 EdgeWorkers 报告。 |
配置列表 | 获取配置文件中的所有值。 |
配置获取
| 从配置文件中的某个部分获取配置值。 |
配置集
| 在部分中设置配置值。 |
配置保存-p | 将配置属性保存在一个部分中。 |
配置取消设置
| 取消设置部分中的配置值。 |
客户开发人员可以根据 Luna 访问控制组找到其 EdgeWorkers 访问级别。
用法: akamai edgeworkers list-groups [options] [group-identifier]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
组标识符 | 选修的 | 用于检查 EdgeWorkers 权限的 Luna Access Group 值(通常为数字) |
输出仅过滤到至少具有一项 EdgeWorkers 功能的 Luna 访问控制组。
功能可以是:查看、查看版本、编辑、查看激活、创建版本、激活
列出当前注册的 EdgeWorker ID。
用法: akamai edgeworkers list-ids [options] [edgeworker-identifier]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--groupId
| 按权限组过滤 EdgeWorker ID 列表 |
--resourceTierId
| 按资源层过滤 EdgeWorker ID |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 选修的 | EdgeWorkers 实例的唯一整数句柄 |
注册一个新的 EdgeWorker ID 以在 Property Manager 行为中引用。
用法: akamai edgeworkers register [options]
选项 | 描述 |
---|---|
--资源层ID | EdgeWorker 将关联到的新资源层 ID。 |
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
组标识符 | 必需的 | 用于检查 EdgeWorkers 权限的 Luna Access Group 值(通常为数字) |
边缘工人姓名 | 必需的 | 描述 EdgeWorkers 实例的人类可读的短标签 |
位置响应标头将提供新的 EdgeWorker Id。
EdgeWorker ID 详细信息响应正文 (JSON) 将随 201 响应代码一起提供。
要禁用自动化目的的提示,可以提供“resourceTierId”作为输入。
允许客户开发人员更新现有 EdgeWorker 标识符的 Luna ACG 或名称属性。
用法: akamai edgeworkers update-id [options]
选项 | 描述 |
---|---|
--资源层ID | EdgeWorker 将关联到的新资源层 ID |
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
组标识符 | 必需的 | 用于检查 EdgeWorkers 权限的 Luna Access Group 值(通常为数字) |
边缘工人姓名 | 必需的 | 描述 EdgeWorkers 实例的人类可读的短标签 |
API 要求提供 groupId 和 name,即使只更改这些属性之一。
EdgeWorker ID 详细信息响应正文 (JSON) 将随 200 响应代码一起提供。
提供的资源层 ID 应与 EdgeWorker ID 已有的资源层 ID 相同。为了提供不同的资源层id,请使用克隆操作。
永久删除现有的 EdgeWorker 标识符。
用法: akamai edgeworkers delete-id [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--无提示 | 跳过删除确认提示 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
仅当 EdgeWorker ID 当前没有任何版本处于活动状态或在 Akamai 网络上激活时,才可以删除该 ID。
确保在删除之前没有与 EdgeWorker 关联的活动属性。
列出给定 EdgeWorker Id 的版本信息。
用法: akamai edgeworkers list-versions [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
版本标识符 | 选修的 | EdgeWorkers 实例版本的唯一整数句柄 |
结果集按未显示的上传序列值(内部递增整数)排序。
EdgeWorker 版本是客户定义的字符串。
创建给定 EdgeWorker Id 的新版本,其中包括代码包。
用法: akamai edgeworkers upload [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--bundle
| tgz 格式的捆绑文件路径 |
--codeDir
| 包含 main.js 和 bundle.json 文件的工作目录 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
必须提供--bundle
或--codeDir
之一(但不能同时提供两者)。
代码包路径和文件必须在本地文件系统上找到。
--bundle
需要一个已经按照 EdgeWorkers 规范构建的 tgz 文件。
--codeDir
需要一个包含 main.js (事件文件)和 bundle.json (清单文件)的目录路径。
--codeDir
选项将提供bundle.json 格式验证。
--codeDir
不打包 main.js 和 bundle.json 之外的其他目录或代码。
--codeDir
如果文件验证成功,将构建 tarball (tgz) 文件。
服务会将新 tarball 的校验和与之前上传的具有相同 EdgeWorker ID ( ewId
) 的 tarball 进行比较。如果找到匹配项,则不允许创建新版本。
versionId
是客户生成的,将从bundle.json 中提取。
位置响应标头将提供新的 EdgeWorker 版本 ID。
EdgeWorker 版本详细信息响应正文 (JSON) 将随 201 响应代码一起提供。
永久删除给定 EdgeWorker Id 的现有版本。
用法: akamai edgeworkers delete-version [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--无提示 | 跳过删除确认提示 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
版本标识符 | 必需的 | EdgeWorkers 实例版本的唯一整数句柄 |
仅当某个版本当前未处于活动状态或未在 Akamai 网络上激活时,才可以删除该版本。
如果该版本当前处于活动状态,则必须先将其停用才能删除。
下载EdgeWorker版本的代码包。
用法: akamai edgeworkers download [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--downloadPath
| 下载的捆绑文件的存储路径;如果未提供,则默认为 CLI 主目录。 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
版本标识符 | 必需的 | EdgeWorkers 实例版本的唯一整数句柄 |
如果未提供--downloadPath
或在本地文件系统上找不到 --downloadPath,则将使用 AkamaiCLI 缓存子目录:
下载包含 EdgeWorker 执行的代码和依赖项的组合代码包。
用法: akamai edgeworkers download-revision [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--downloadPath
| 下载的组合包文件的存储路径;如果未提供,则默认为 CLI 主目录。 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | EdgeWorkers 实例特定的唯一修订标识符 |
如果未提供--downloadPath
或在本地文件系统上找不到 --downloadPath,则将使用 AkamaiCLI 缓存子目录:
列出给定 EdgeWorker Id 的激活状态。
用法: akamai edgeworkers status [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--versionId
| 版本标识符 |
--activationId
| 激活标识符 |
--activeOnNetwork | 将结果限制为仅显示当前激活的版本 |
--network
| 将结果限制为在特定网络(暂存或生产)上激活的版本 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
您不得同时提供版本和激活标识符。
列出给定 EdgeWorker ID 的修订历史记录。
用法: akamai edgeworkers list-revisions [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--versionId
| 版本标识符 |
--activationId
| 激活标识符 |
--仅固定 | 将结果限制为仅显示当前或之前固定的修订 |
--当前固定 | 将结果限制为仅显示当前固定的修订 |
--network
| 将结果限制为在特定网络(暂存或生产)上激活的版本 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
网络必须是暂存或生产。大写将标准化为大写。
获取特定修订的详细信息。
用法: akamai edgeworkers get-revision [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | 修订标识符 |
查看同一 EdgeWorker 的两个修订版之间的依赖性差异。
用法: akamai edgeworkers compare-revisions [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | 第一修订版标识符 |
修订标识符 | 必需的 | 第二次修订标识符 |
两个版本标识符必须不同。
激活 Akamai 网络上给定 EdgeWorker ID 的修订版。
用法: akamai edgeworkers activate-revision [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
- 笔记 | 请注意指定重新激活修订版本的原因 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | 修订标识符 |
该修订版将在其先前处于活动状态的同一网络(生产或暂存)上重新激活。
固定给定 EdgeWorker ID 的活动修订版。
用法: akamai edgeworkers pin-revision [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
- 笔记 | 请注意指定修订版本被固定的原因 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | 修订标识符 |
必须在固定之前激活修订版本。
取消固定给定 EdgeWorker ID 的活动固定修订版本。
用法: akamai edgeworkers unpin-revision [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
- 笔记 | 请注意指定取消固定修订版本的原因 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | 修订标识符 |
取消固定之前必须固定修订版本。
查看复合捆绑包特定修订版的详细信息。
用法: akamai edgeworkers get-revision-bom [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--activeVersions | 将结果限制为仅显示活动版本 |
--当前固定修订 | 显示有关当前固定修订版本的附加信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
修订标识符 | 必需的 | 修订标识符 |
列出给定 EdgeWorker ID 的修订激活状态。
用法: akamai edgeworkers list-revision-activations [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--版本号 | 版本标识符 |
--激活ID | 激活标识符 |
- 网络 | 将结果限制为在特定网络(暂存或生产)上激活的版本 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
您不得同时提供版本和激活标识符。
网络必须是暂存或生产。大写将标准化为大写。
在 Akamai 网络上激活给定 EdgeWorker ID 的版本。
用法: akamai edgeworkers activate [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
网络 | 必需的 | Akamai 网络(暂存或生产)激活应发送至的标签 |
版本标识符 | 必需的 | EdgeWorkers 实例版本的唯一整数句柄 |
网络必须是暂存或生产。大写将标准化为大写。
位置响应标头将随新的 EdgeWorker 激活 ID 一起提供。
EdgeWorker 激活详细信息响应正文 (JSON) 将随 201 响应代码一起提供。
验证代码包版本而不上传代码包
用法: akamai edgeworkers validate [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
捆绑路径 | 必需的 | tgz 格式的捆绑文件路径 |
必须在本地文件系统上找到代码包路径。
代码包需要一个已根据 EdgeWorkers 规范构建的 tgz 文件。
停用 Akamai 网络上给定 EdgeWorker ID 的版本。
用法: akamai edgeworkers deactivate [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorkers 实例的唯一整数句柄 |
网络 | 必需的 | Akamai 网络(暂存或生产)激活应发送至的标签 |
版本标识符 | 必需的 | EdgeWorkers 实例版本的唯一整数句柄 |
网络必须是暂存或生产。大写将标准化为大写。
位置响应标头将随新的 EdgeWorker 激活 ID 一起提供。
EdgeWorker 激活详细信息响应正文 (JSON) 将随 201 响应代码一起提供。
生成可用于获取详细 EdgeWorker 调试响应标头的身份验证令牌。您至少需要 EdgeWorkers CLI 版本 1.7.1 才能运行此命令。使用 -V, --version 选项显示 EdgeWorkers CLI 的当前版本号。
用法: akamai edgeworkers create-auth-token [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--expiry
| 令牌的有效期(以分钟为单位)。 |
--format
| 打印输出的格式 |
争论 | 存在 | 描述 |
---|---|---|
主机名 | 可选的 | 属性的主机名。如果未提供主机名,则会为该属性下的所有主机 ( /* ) 创建令牌。例如:www.test.com、www.test1.com |
--expiry
值必须介于 1 到 720 分钟(12 小时)之间。默认值为8 hours
。
允许客户从现有 EdgeWorker ID 克隆 EdgeWorker。
用法: akamai edgeworkers clone
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--新名称 | EdgeWorker 的名称 |
--组ID | 组标识符 |
争论 | 存在 | 描述 |
---|---|---|
资源TierId | 必需的 | EdgeWorker 将克隆到的资源层 ID。 |
此端点允许用户通过克隆特定 EdgeWorker ID 来选择不同的资源层 ID。克隆到同一资源层将会失败。
用户有权访问的合约 ID 列表。
用法: akamai list-contracts
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
与特定 EdgeWorker Id 关联的属性列表。
用法: akamai edgeworkers list-properties
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
--仅活动 | 仅返回活动属性 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | EdgeWorker 标识符。 |
请注意,如果用户无权访问帐户下的顶级组,或者他们不具有该组的管理员角色,则返回的布尔 limitAccessToProperties 为 true。
列出 EdgeWorkers 对激活数量、EdgeWorkers ID 和您可以部署的版本施加的各种限制。
用法: akamai edgeworkers list-limits [options]
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
列出可用于创建或克隆 EdgeWorker ID 的资源层。
用法: akamai list-restiers
选项 | 描述 |
---|---|
--合约ID | 指定合约 ID 的资源层。 |
-h,--帮助 | 输出使用信息 |
将提示用户提供其有权访问的合约 ID 列表。选定的合约 ID 将用于获取资源层。
要禁用自动化提示,可以提供合约 ID 作为输入。
客户可以获得特定 EdgeWorker ID 的资源层详细信息。
用法: akamai show-restier
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人ID | 必需的 | EdgeWorker标识符 |
列出可为 EdgeWorker ID 生成的可用报告类型。
用法: akamai get reports
选项 | 描述 |
---|---|
-h,--帮助 | 输出使用信息 |
将向用户提供一个包含报告 ID 和每个报告的描述的表格。将给定的 reportId 与get report
命令结合使用,以获取给定 EdgeWorker 的报告。
获取给定 EdgeWorker ID 的报告。
用法: akamai get report
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
-s, --startDate
| 必需的 | ISO 8601 时间戳,指示 EdgeWorkers 报告的开始时间。 |
-e, --endDate
| 选修的 | ISO 8601 时间戳,指示 EdgeWorkers 报告的结束时间。如果不指定,结束时间默认为当前时间。 |
--status
| 选修的 | 按 EdgeWorkers 状态过滤的逗号分隔字符串。值: success 、 genericError 、 unknownEdgeWorkerId 、 unimplementedEventHandler 、 runtimeError 、 executionError 、 timeoutError 、 resourceLimitHit 、 cpuTimeoutError 、 wallTimeoutError 、 initCpuTimeoutError 、 initWallTimeoutError 。 |
--ev, --eventHandlers
| 选修的 | 以逗号分隔的字符串,用于按触发 EdgeWorkers 的事件来过滤它们。值: onClientRequest 、 onOriginRequest 、 onOriginResponse 、 onClientResponse 、 responseProvider 。 |
争论 | 存在 | 描述 |
---|---|---|
报告编号 | 必需的 | 报告类型。 |
边缘工人标识符 | 必需的 | EdgeWorker 标识符。 |
要获取可用报告 ID 的列表,请使用get reports
命令。
startDate
选项是必需选项。
获取配置文件的一部分中的所有默认属性。
用法: akamai config list
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
默认情况下,配置部分是default
。要使用不同的部分,用户应使用选项--configSection
指定akamai edgeworkers
命令。
相同的方法应适用于以下config
命令。
获取配置文件的一部分中的一个特定默认值。
用法: akamai config get
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
钥匙 | 必需的 | 默认属性名称 |
允许客户在配置文件的一部分中设置/更新特定的默认值。
用法: akamai config set
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
钥匙 | 必需的 | 默认属性名称 |
价值 | 必需的 | 默认属性的值 |
允许客户取消设置配置文件部分中的特定默认值。
用法: akamai config unset
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
钥匙 | 必需的 | 默认属性名称 |
允许客户批量保存默认值。
用法: akamai config save [options]
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
-p, --属性 | 必需的 | 配置属性。使用格式“key=value”设置属性和空格来分割它们。 |
如果上下文包含无效项目,该命令将跳过该项目并继续。
允许客户查看边缘工作人员的日志记录级别覆盖的详细信息。
用法: akamai edgeworkers log-level get [options]
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | 要显示日志记录级别覆盖信息的 EdgeWorker 标识符。 |
记录标识符 | 选修的 | 要显示的日志记录级别覆盖的日志记录 ID。 |
如果未指定logging-identifier
,则将显示所有日志记录级别覆盖。
logging-identifier
是一个数字常量,用于标识日志级别覆盖。它可以在覆盖创建期间获得,或者通过列出所有覆盖而不提供可选参数并查找特定覆盖的loggingId
字段来获取。
允许客户设置 EdgeWorker 的日志记录级别。
用法: akamai edgeworkers log-level set [options]
选项 | 存在 | 描述 |
---|---|---|
-h,--帮助 | 选修的 | 输出使用信息 |
--过期 | 选修的 | 指定用户的日志记录级别覆盖将应用多长时间。通过后,日志记录级别将恢复为捆绑包中指定的默认值。 |
--ds2Id | 选修的 | 与 EdgeWorker 的bundle.json 文件中指定的数据流 ID 一起使用。 |
争论 | 存在 | 描述 |
---|---|---|
边缘工人标识符 | 必需的 | 要更改其日志记录级别的 EdgeWorker 标识符。 |
网络 | 必需的 | 要应用新日志记录级别的网络。要么是“制作”,要么是“演出”。 |
等级 | 必需的 | 应用于 EdgeWorker 的新日志记录级别。有关可能的值,请参阅客户记录文档。 |
只有最近创建的日志级别覆盖才有效。
当覆盖过期时,日志记录级别将重置为 Edgeworker 的bundle.json
文件中指定的级别。
如果命令成功,则会打印日志级别覆盖详细信息,其中包括覆盖的loggingId
。通过使用log-level get
子命令并将其传递给logging-identifier
可选参数, loggingId
可用于随时获取这些详细信息。
如果未指定--expires
选项,则默认覆盖永不过期。
--expires
选项支持自然语言输入和标准时间戳。请参阅chrono
包文档以获取完整规格。
将生产网络上的日志级别覆盖设置为信息级别,该级别将在 1 小时后过期。
./akamai-edgeworkers log-level set 654321 production info --expires 1h
将暂存网络上的日志级别覆盖设置为跟踪级别,该级别将于 2024 年 8 月 13 日 CEST(中欧夏令时间)下午 3 点到期。
./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"
有关 EdgeWorkers 的更多信息,请参阅以下资源:
EdgeWorkers 开发者页面
EdgeWorkers 用户指南
EdgeWorkers API 指南
您已准备就绪,祝您编码愉快!如果您在使用 EdgeWorkers CLI 时遇到任何问题,请将其作为 github 问题提出。请随意创建包含修复或建议的拉取请求。
我们欢迎 Akamai 员工、客户或其他人做出贡献。在打开 PR 之前,请仔细检查以下内容:
请添加一些测试用例来配合您的 PR。这验证了 PR 中添加或修改的功能,并向其他人证明您的代码可以工作:)
请确保您的代码通过所有预提交检查。您的代码应该成功构建,通过所有单元测试,并且没有 linting 问题。
所有 PR 都应该以开发为目标,而不是掌握。合并到master后将立即发布给所有客户。