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 initWallTimeoutError timeoutError 、 resourceLimitHit 、 cpuTimeoutError 、 wallTimeoutError 、 initCpuTimeoutError 、wall |
--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後將立即發布給所有客戶。