cli エッジワーカー

エッジワーカー CLI

EdgeWorkers CLI EdgeWorkers コマンド ライン インターフェイス (CLI) は、Akamai Edge ネットワーク上での EdgeWorkers 機能の登録、アップロード、アクティブ化、テストのプロセスを迅速化します。

EdgeKV データベースを管理し、コマンドラインから EdgeKV API を呼び出す方法については、「Akamai CLI for EdgeKV」にアクセスしてください。

技術的なセットアップ要件

このツールを使用するには、次のものが必要です。

• Akamai CLI がインストールされています。

• CLI がなく、Mac で Homebrew を使用している場合は、次のコマンドを実行します: brew install akamai

• OS 固有の CLI バイナリまたは Docker イメージをダウンロードすることもできます。

• Akamai Control Center 経由で構成された有効な EdgeGrid 認証情報 (「API の使用を開始する」を参照)

• ノードのバージョン 14 以降

EdgeWorkers のインストールまたは更新

• EdgeWorkers CLI パッケージがインストールされていない場合は、次の Akamai CLI コマンドを使用して最新の EdgeWorkers CLI パッケージをインストールします。

使用法：
akamai install edgeworkers

• すでに CLI がインストールされている場合は、次の Akamai CLI コマンドを使用して、EdgeKV 機能を含む最新の EdgeWorkers CLI パッケージをインストールします。

使用法：
akamai update edgeworkers

デフォルトの構成プロパティを提供する

EdgeWorkers CLI を使用すると、コマンド オプションのデフォルト値を設定できます。構成ファイルを作成するには 2 つの方法があります。

1. 構成ファイル~/.akamai-cli/ew-configを作成し、次のようにプロパティを保存します。

 [デフォルト]
エッジワーカー名=testEW
グループID=12345
バージョンID=1-0-2

2. configコマンドを使用してデフォルトのプロパティを設定します: akamai edgeworkers config set

利用可能なプロパティ名がここに表示されます。

コマンドの概要

EdgeWorkers CLI を使用すると、EdgeWorkers API を呼び出して EdgeWorkers 機能を管理できます。

規約:

• オプションの引数[]

• 必須の引数<>

使用法：
akamai edgeworkers [options] [command]

オプション:

構文	説明
-V、--バージョン	EdgeWorkers CLI プログラムのバージョン番号を表示します。
- デバッグ	デバッグ情報を表示します。
--edgerc	コマンドにはedgercファイル内の認証情報を使用します。 (デフォルトのファイルの場所は~/.edgercです)
--セクション	このセクションはedgercファイルで使用します。 (デフォルトのセクションは[default]です)
--configSection	デフォルトの構成プロパティ セットを含むew-configファイルでこのセクションを使用します。 (デフォルトのセクションは[default]です)
--timeout	コマンドのタイムアウト値を秒単位で指定して、デフォルトの 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 を登録します。
更新ID | ui [options]	顧客開発者が既存の EdgeWorker Identifier の Luna ACG または Name 属性を更新できるようにします。
削除ID | delete-id [options]	既存の EdgeWorker ID を完全に削除します。
リストバージョン | lv [version-identifier]	指定された EdgeWorker ID のバージョン情報をリストします。
アップロード | create-version [options]	コード バンドルを含む、指定された EdgeWorker ID の新しいバージョンを作成します。
削除バージョン | delete-version [options]	特定の EdgeWorker ID の既存のバージョンを完全に削除します。
ダウンロード |ダウンロード バージョン[options]	EdgeWorker バージョンのコード バンドルをダウンロードします。
ダウンロード-リビジョン | dr [options]	EdgeWorker が実行するコードと依存関係を含む、結合されたコード バンドルをダウンロードします。
ステータス | list-activations [options]	指定された EdgeWorker ID のアクティブ化ステータスをリストします。
リストリビジョン | lr [options]	特定の EdgeWorker ID のリビジョン履歴を一覧表示します。
リビジョンの取得 | gr	特定のリビジョンの詳細を取得します。
リビジョンの比較 | cr	同じ EdgeWorker の 2 つのリビジョン間の依存関係の違いを表示します。
リビジョンのアクティブ化 | ar [options]	Akamai ネットワーク上の特定の EdgeWorker ID のリビジョンをアクティブ化します。
pin-revision [options]	特定の EdgeWorker ID のアクティブなリビジョンを固定します。
unpin-revision [options]	特定の EdgeWorker ID のアクティブな固定リビジョンの固定を解除します。
リビジョンボムを取得 | gb [options]	複合バンドルの特定のリビジョンの詳細を表示します。
リスト-リビジョン-アクティベーション | lra [options]	指定された EdgeWorker ID のリビジョン アクティベーション ステータスをリストします。
アクティブにする | av	Akamai ネットワーク上で特定の EdgeWorker ID のバージョンをアクティブ化します。
無効にする | deact	Akamai ネットワーク上の特定の EdgeWorker ID のバージョンを非アクティブ化します。
検証する | vv	コード バンドルをアップロードせずに、コード バンドルのバージョンを検証します。
認証トークンの作成 |認証[options]	詳細な EdgeWorker デバッグ応答ヘッダーを取得するために使用できる認証トークンを生成します。このコマンドを実行するには、少なくともバージョン 1.7.1 の EdgeWorkers CLI が必要です。
クローン | clone [options]	既存の EdgeWorker ID から EdgeWorker のクローンを作成します。
リスト-契約 |無償契約[options]	ユーザーがアクセスできる契約 ID のリスト。
リストのプロパティ | lp [options]	特定の EdgeWorker ID に関連付けられたプロパティのリスト。
リスト制限 |リミット	EdgeWorkers がアクティベーション数、EdgeWorkers ID、展開できるバージョンに課すさまざまな制限を表示します。
リスト-レストラン |リ・レスティア[options]	EdgeWorker ID の作成または複製に使用できるリソース層をリストします。
ショーレスティエ | show-restier	お客様は、特定の EdgeWorker ID のリソース層の詳細を取得できます。
レポートを取得する	利用可能なすべての EdgeWorkers レポートのリストを取得します。
レポートの取得 [options]	特定の EdgeWorker ID の EdgeWorkers レポートを取得します。
構成リスト	構成ファイル内のすべての値を取得します。
config get	構成ファイル内のセクションから構成値を取得します。
config set	セクションに設定値を設定します。
config save -p	構成プロパティをセクションに保存します。
config unset	セクション内の構成値の設定を解除します。

EdgeWorkers アクセスを持つ権限グループをリストする

顧客開発者は、Luna アクセス コントロール グループごとに EdgeWorkers アクセス レベルを確認できます。

使用法: akamai edgeworkers list-groups [options] [group-identifier]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
グループ識別子	オプション	EdgeWorkers 権限を確認するための Luna アクセス グループ値 (通常は数値)

主要な詳細

1. 出力は、少なくとも 1 つの EdgeWorkers 機能を持つ Luna アクセス コントロール グループのみにフィルターされます。

2. 機能は次のとおりです: VIEW、VIEW_VERSION、EDIT、VIEW_ACTIVATION、CREATE_VERSION、ACTIVATE

既存の EdgeWorker 識別子のリスト

現在登録されている EdgeWorker ID を一覧表示します。

使用法: akamai edgeworkers list-ids [options] [edgeworker-identifier]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--groupId	EdgeWorker ID リストを権限グループでフィルタリングする
--resourceTierId	リソース層による EdgeWorker ID のフィルター

口論	存在	説明
エッジワーカー識別子	オプション	EdgeWorkers インスタンスへの一意の整数ハンドル

新しい EdgeWorker 識別子の登録

プロパティ マネージャーの動作で参照する新しい EdgeWorker ID を登録します。

使用法: akamai edgeworkers register [options]

オプション	説明
--resourceTierId	EdgeWorker が関連付けられる新しいリソース層 ID。
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
グループ識別子	必須	EdgeWorkers 権限を確認するための Luna アクセス グループ値 (通常は数値)
エッジワーカー名	必須	EdgeWorkers インスタンスを説明する人間が判読できる短いラベル

主要な詳細

1. 位置応答ヘッダーには新しい EdgeWorker ID が提供されます。

2. EdgeWorker ID の詳細の応答本文 (JSON) には 201 応答コードが提供されます。

3. 自動化の目的でプロンプトを無効にするには、「resourceTierId」を入力として指定できます。

EdgeWorker 識別子の情報を更新する

顧客開発者が既存の EdgeWorker Identifier の Luna ACG または Name 属性を更新できるようにします。

使用法: akamai edgeworkers update-id [options]

オプション	説明
--resourceTierId	EdgeWorker が関連付けられる新しいリソース層 ID
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
グループ識別子	必須	EdgeWorkers 権限を確認するための Luna アクセス グループ値 (通常は数値)
エッジワーカー名	必須	EdgeWorkers インスタンスを説明する人間が判読できる短いラベル

主要な詳細

1. API では、groupId と name のどちらかの属性を変更するだけの場合でも、両方を指定する必要があります。

2. EdgeWorker ID の詳細の応答本文 (JSON) には 200 応答コードが提供されます。

3. 指定するリソース層 ID は、EdgeWorker ID がすでに持っているものと同じである必要があります。別のリソース層 ID を指定するには、クローン操作を使用してください。

既存の EdgeWorker 識別子の削除

既存の EdgeWorker 識別子を完全に削除します。

使用法: akamai edgeworkers delete-id [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--noプロンプト	削除確認プロンプトをスキップする

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル

主要な詳細

1. EdgeWorker ID の削除は、現在アクティブなバージョンがない場合、または Akamai ネットワーク上でアクティブ化されているバージョンがない場合にのみ可能です。

2. 削除する前に、EdgeWorker に関連付けられているアクティブなプロパティがないことを確認してください。

EdgeWorker バージョンの一覧表示

指定された EdgeWorker ID のバージョン情報をリストします。

使用法: akamai edgeworkers list-versions [options] [version-identifier]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
バージョン識別子	オプション	EdgeWorkers インスタンスのバージョンへの一意の整数ハンドル

主要な詳細

1. 結果セットは、表示されないアップロード シーケンス値 (内部的に増加する整数) によって並べ替えられます。

2. EdgeWorker のバージョンは顧客定義の文字列です。

新しい EdgeWorker バージョンをアップロードする

コード バンドルを含む、指定された EdgeWorker ID の新しいバージョンを作成します。

使用法: akamai edgeworkers upload [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--bundle	tgz形式のバンドルファイルへのパス
--codeDir	main.js ファイルと Bundle.json ファイルを含む作業ディレクトリ

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル

主要な詳細

1. --bundleまたは--codeDirのいずれか (両方ではなく) を指定する必要があります。

2. コード バンドルのパスとファイルはローカル ファイル システム上に存在する必要があります。

3. --bundle EdgeWorkers 仕様に従ってすでに構築された tgz ファイルを想定しています。

4. --codeDir main.js (イベント ファイル) と Bundle.json (マニフェスト ファイル) の両方を含むディレクトリ パスを期待します。

5. --codeDirオプションは、bundle.json 形式の検証を提供します。

6. --codeDir main.js と Bundle.json を超える他のディレクトリやコードをパックしません。

7. --codeDirファイルの検証が成功した場合に tarball (tgz) ファイルをビルドします。

8. サービスは、新しい tarball のチェックサムを、同じ EdgeWorker ID ( ewId ) に対して以前にアップロードされた tarball と比較します。一致するものが見つかった場合、新しいバージョンの作成は許可されません。

9. versionIdは顧客が生成し、bundle.json から取得されます。

10. 位置応答ヘッダーには、新しい EdgeWorker バージョン ID が提供されます。

11. EdgeWorker バージョンの詳細の応答本文 (JSON) は、201 応答コードとともに提供されます。

既存の EdgeWorker バージョンの削除

特定の EdgeWorker ID の既存のバージョンを完全に削除します。

使用法: akamai edgeworkers delete-version [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--noプロンプト	削除確認プロンプトをスキップする

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
バージョン識別子	必須	EdgeWorkers インスタンスのバージョンへの一意の整数ハンドル

主要な詳細

1. バージョンの削除は、そのバージョンが現在アクティブでない場合、または Akamai ネットワーク上でアクティブ化されている場合にのみ可能です。

2. バージョンが現在アクティブな場合、削除する前に非アクティブ化する必要があります。

EdgeWorkers コードバンドルをダウンロードする

EdgeWorker バージョンのコード バンドルをダウンロードします。

使用法: akamai edgeworkers download [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--downloadPath	ダウンロードしたバンドル ファイルを保存するパス。指定しない場合、デフォルトは CLI ホーム ディレクトリです。

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
バージョン識別子	必須	EdgeWorkers インスタンスのバージョンへの一意の整数ハンドル

主要な詳細

1. --downloadPathが指定されていないか、ローカル ファイルシステムで見つからない場合は、AkamaiCLI キャッシュ サブディレクトリが使用されます: /edgeworkers-cli/edgeworkers//

EdgeWorkers 結合コード バンドルをダウンロードする

EdgeWorker が実行するコードと依存関係を含む、結合されたコード バンドルをダウンロードします。

使用法: akamai edgeworkers download-revision [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--downloadPath	ダウンロードされた結合バンドル ファイルを保存するパス。指定しない場合、デフォルトは CLI ホーム ディレクトリです。

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	特定の EdgeWorkers インスタンスに対する一意のリビジョン識別子

主要な詳細

1. --downloadPathが指定されていないか、ローカル ファイルシステムで見つからない場合は、AkamaiCLI キャッシュ サブディレクトリが使用されます: /edgeworkers-cli/edgeworkers//

EdgeWorker バージョンのアクティベーション ステータスの一覧表示

指定された EdgeWorker ID のアクティブ化ステータスをリストします。

使用法: akamai edgeworkers status [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--versionId	バージョン識別子
--activationId	アクティベーション識別子
--activeOnNetwork	現在アクティブ化されているバージョンのみを表示するように結果を制限します
--network	結果を特定のネットワーク (ステージングまたはプロダクション) でアクティブ化されたバージョンに限定します

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル

主要な詳細

1. バージョン識別子とアクティベーション識別子の両方を指定することはできません。

EdgeWorker のリビジョン履歴を一覧表示する

特定の EdgeWorker ID のリビジョン履歴を一覧表示します。

使用法: akamai edgeworkers list-revisions [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--versionId	バージョン識別子
--activationId	アクティベーション識別子
--pinnedOnly	現在または以前に固定されたリビジョンのみを表示するように結果を制限します
--現在固定されています	現在固定されているリビジョンのみを表示するように結果を制限します
--network	結果を特定のネットワーク (ステージングまたはプロダクション) でアクティブ化されたバージョンに限定します

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル

主要な詳細

1. ネットワークはステージングまたはプロダクションである必要があります。大文字は大文字に正規化されます。

EdgeWorker のリビジョンの詳細を取得する

特定のリビジョンの詳細を取得します。

使用法: akamai edgeworkers get-revision [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	リビジョン識別子

EdgeWorker の 2 つのリビジョンの詳細を比較する

同じ EdgeWorker の 2 つのリビジョン間の依存関係の違いを表示します。

使用法: akamai edgeworkers compare-revisions [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	最初のリビジョン識別子
リビジョン識別子	必須	2 番目のリビジョン識別子

主要な詳細

1. 両方のリビジョン識別子は異なっている必要があります。

EdgeWorker のリビジョンをアクティブ化する

Akamai ネットワーク上で特定の EdgeWorker ID のリビジョンをアクティブ化します。

使用法: akamai edgeworkers activate-revision [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
- 注記	リビジョンを再アクティブ化する理由を指定するためのメモ

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	リビジョン識別子

主要な詳細

1. リビジョンは、以前にアクティブであったのと同じネットワーク (本番またはステージング) 上で再アクティブ化されます。

EdgeWorker のピン リビジョン

特定の EdgeWorker ID のアクティブなリビジョンを固定します。

使用法: akamai edgeworkers pin-revision [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
- 注記	リビジョンが固定されている理由を指定するためのメモ

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	リビジョン識別子

主要な詳細

1. リビジョンは固定する前にアクティブ化する必要があります。

EdgeWorker のリビジョンの固定を解除する

特定の EdgeWorker ID のアクティブな固定リビジョンの固定を解除します。

使用法: akamai edgeworkers unpin-revision [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
- 注記	リビジョンの固定を解除する理由を指定するためのメモ

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	リビジョン識別子

主要な詳細

1. リビジョンは固定を解除する前に固定する必要があります。

EdgeWorker のリビジョンの詳細を取得する

複合バンドルの特定のリビジョンの詳細を表示します。

使用法: akamai edgeworkers get-revision-bom [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--activeVersions	結果を制限してアクティブなバージョンのみを表示する
--currentlyPinnedRevisions	現在固定されているリビジョンに関する追加情報を表示します

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
リビジョン識別子	必須	リビジョン識別子

EdgeWorker のリビジョン アクティベーションをリストする

指定された EdgeWorker ID のリビジョン アクティベーション ステータスをリストします。

使用法: akamai edgeworkers list-revision-activations [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--versionId	バージョン識別子
--activationId	アクティベーション識別子
- ネットワーク	結果を特定のネットワーク (ステージングまたはプロダクション) でアクティブ化されたバージョンに限定します

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル

主要な詳細

1. バージョン識別子とアクティベーション識別子の両方を指定することはできません。

2. ネットワークはステージングまたはプロダクションである必要があります。大文字は大文字に正規化されます。

EdgeWorker をアクティブ化する

Akamai ネットワーク上で特定の EdgeWorker ID のバージョンをアクティブ化します。

使用法: akamai edgeworkers activate [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
ネットワーク	必須	Akamai ネットワーク (ステージングまたはプロダクション) のアクティベーションを送信するラベル
バージョン識別子	必須	EdgeWorkers インスタンスのバージョンへの一意の整数ハンドル

主要な詳細

1. ネットワークはステージングまたはプロダクションである必要があります。大文字は大文字に正規化されます。

2. 位置応答ヘッダーには、新しい EdgeWorker アクティベーション ID が提供されます。

3. EdgeWorker アクティベーション詳細の応答本文 (JSON) には 201 応答コードが提供されます。

EdgeWorkers コード バンドルを検証する

コード バンドルをアップロードせずにコード バンドルのバージョンを検証します

使用法: akamai edgeworkers validate [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
バンドルパス	必須	tgz形式のバンドルファイルへのパス

主要な詳細

1. コード バンドルのパスはローカル ファイル システム上で見つかる必要があります。

2. コード バンドルでは、EdgeWorkers 仕様に従ってすでに構築された tgz ファイルが必要です。

EdgeWorker を非アクティブ化する

Akamai ネットワーク上の特定の EdgeWorker ID のバージョンを非アクティブ化します。

使用法: akamai edgeworkers deactivate [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorkers インスタンスへの一意の整数ハンドル
ネットワーク	必須	Akamai ネットワーク (ステージングまたはプロダクション) のアクティベーションを送信するラベル
バージョン識別子	必須	EdgeWorkers インスタンスのバージョンへの一意の整数ハンドル

主要な詳細

1. ネットワークはステージングまたはプロダクションである必要があります。大文字は大文字に正規化されます。

2. 位置応答ヘッダーには、新しい EdgeWorker アクティベーション ID が提供されます。

3. EdgeWorker アクティベーション詳細の応答本文 (JSON) には 201 応答コードが提供されます。

EdgeWorkers 認証トークンを作成する

詳細な EdgeWorker デバッグ応答ヘッダーを取得するために使用できる認証トークンを生成します。このコマンドを実行するには、少なくともバージョン 1.7.1 の EdgeWorkers CLI が必要です。 EdgeWorkers CLI の現在のバージョン番号を表示するには、-V, --version オプションを使用します。

使用法: akamai edgeworkers create-auth-token [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--expiry	トークンの有効期限 (分単位)。
--format	出力が印刷される形式

口論	存在	説明
ホスト名	任意の	プロパティのホスト名。ホスト名が指定されていない場合は、プロパティの下のすべてのホスト ( /* ) に対してトークンが作成されます。例: www.test.com、www.test1.com

主要な詳細

1. --expiry値は 1 ～ 720 分 (12 時間) である必要があります。デフォルトは8 hoursです。

EdgeWorker ID のクローンを作成する

顧客が既存の EdgeWorker ID から EdgeWorker を複製できるようにします。

使用法: akamai edgeworkers clone [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--ewName	エッジワーカーの名前
--グループID	グループ識別子

口論	存在	説明
リソースTierId	必須	EdgeWorker の複製先となるリソース層 ID。

主要な詳細

1. このエンドポイントを使用すると、ユーザーはクローンを作成することで、特定の EdgeWorker ID に対して別のリソース層 ID を選択できます。同じリソース層へのクローン作成は失敗します。

契約の一覧表示

ユーザーがアクセスできる契約 ID のリスト。

使用法: akamai list-contracts

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

リストのプロパティ

特定の EdgeWorker ID に関連付けられたプロパティのリスト。

使用法: akamai edgeworkers list-properties [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する
--activeOnly	アクティブなプロパティのみを返します

口論	存在	説明
エッジワーカー識別子	必須	EdgeWorker の識別子。

主要な詳細

1. ユーザーがアカウントの最上位グループにアクセスできない場合、またはこのグループの管理者ロールを持っていない場合、返されるブール値のlimitedAccessToPropertiesはtrueになることに注意してください。

リストの制限

EdgeWorkers がアクティベーションの数、EdgeWorkers ID、および展開できるバージョンに課すさまざまな制限をリストします。

使用法: akamai edgeworkers list-limits [options]

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

特定の契約 ID のリソース層をリストする

EdgeWorker ID の作成または複製に使用できるリソース層をリストします。

使用法: akamai list-restiers

オプション	説明
--contractId	指定されたコントラクト ID のリソース層。
-h、--ヘルプ	使用状況情報を出力する

主要な詳細

1. ユーザーには、アクセス権のある契約 ID のリストが表示されます。選択したコントラクト ID は、リソース層を取得するために使用されます。

2. 自動化の目的でプロンプトを無効にするには、入力として契約 ID を指定できます。

特定の EdgeWorker ID のリソース層を取得する

お客様は、特定の EdgeWorker ID のリソース層の詳細を取得できます。

使用法: akamai show-restier

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

口論	存在	説明
エッジワーカーID	必須	エッジワーカー識別子

利用可能な EdgeWorkers レポート タイプを取得する

EdgeWorker ID に対して生成できる利用可能なレポート タイプをリストします。

使用法: akamai get reports

オプション	説明
-h、--ヘルプ	使用状況情報を出力する

主要な詳細

1. ユーザーには、reportIds と各レポートの説明を含むテーブルが与えられます。特定の ReportId をget reportコマンドで使用して、特定の EdgeWorker のレポートを取得します。

EdgeWorker レポートを取得する

指定された EdgeWorker ID のレポートを取得します。

使用法: akamai get report

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する
-s, --startDate	必須	EdgeWorkers レポートの開始時刻を示す ISO 8601 タイムスタンプ。
-e, --endDate	オプション	EdgeWorkers レポートの終了時刻を示す ISO 8601 タイムスタンプ。指定しない場合、終了時刻はデフォルトで現在時刻になります。
--status	オプション	EdgeWorkers のステータスでフィルタリングするためのカンマ区切りの文字列。値: success 、 genericError 、 unknownEdgeWorkerId 、 unimplementedEventHandler 、 runtimeError 、 executionError 、 timeoutError 、 resourceLimitHit 、 cpuTimeoutError 、 wallTimeoutError 、 initCpuTimeoutError 、 initWallTimeoutError 。
--ev、--eventHandlers	オプション	EdgeWorkers をトリガーするイベントによってフィルタリングするためのカンマ区切りの文字列。値: onClientRequest 、 onOriginRequest 、 onOriginResponse 、 onClientResponse 、 responseProvider 。

口論	存在	説明
レポートID	必須	レポートの種類。
エッジワーカー識別子	必須	EdgeWorker の識別子。

主要な詳細

1. 使用可能なレポート ID のリストを表示するには、 get reportsコマンドを使用します。

2. startDateオプションは必須のオプションです。

構成ファイル内のセクションのすべてのデフォルト値をリストする

構成ファイルのセクション内のすべてのデフォルトのプロパティを取得します。

使用法: akamai config list

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する

主要な詳細

1. config セクションはデフォルトでdefaultです。別のセクションを使用するには、ユーザーはオプション--configSection を使用してakamai edgeworkersコマンドを指定する必要があります。

2. 同じアプローチを次のconfigコマンドに適用する必要があります。

構成ファイル内のセクションのデフォルト値を取得する

構成ファイルのセクションで特定のデフォルト値を 1 つ取得します。

使用法: akamai config get

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する

口論	存在	説明
鍵	必須	デフォルトのプロパティの名前

構成ファイル内のセクションのデフォルト値を設定/更新する

顧客が構成ファイルのセクションで特定のデフォルト値を設定/更新できるようにします。

使用法: akamai config set

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する

口論	存在	説明
鍵	必須	デフォルトのプロパティの名前
価値	必須	デフォルトのプロパティの値

構成ファイル内のセクションのデフォルト値の設定を解除する

顧客が構成ファイルのセクションで特定のデフォルト値の設定を解除できるようにします。

使用法: akamai config unset

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する

口論	存在	説明
鍵	必須	デフォルトのプロパティの名前

セクションのデフォルトプロパティを設定ファイルに一括保存

顧客がデフォルト値を一括保存できるようにします。

使用法: akamai config save [options]

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する
-p、--プロパティ	必須	構成プロパティ。形式「key=value」を使用してプロパティを設定し、空白スペースを使用してそれらを分割します。

主要な詳細

1. コンテキストに無効な項目が含まれている場合、コマンドはその項目をスキップして続行します。

EdgeWorker の現在のログ レベルを表示する

顧客がエッジワーカーのログ レベル オーバーライドの詳細を表示できるようにします。

使用法: akamai edgeworkers log-level get [options] [logging-identifier]

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する

口論	存在	説明
エッジワーカー識別子	必須	ログ レベル オーバーライド情報を表示する EdgeWorker 識別子。
ロギング識別子	オプション	表示するログ レベル オーバーライドのログ ID。

主要な詳細

1. logging-identifierが指定されていない場合は、すべてのログ レベルのオーバーライドが表示されます。

2. logging-identifier 、ログ レベルのオーバーライドを識別する数値定数です。これは、オーバーライドの作成中に取得するか、オプションの引数を指定せずにすべてのオーバーライドをリストし、特定のオーバーライドのloggingIdフィールドを検索することによって取得できます。

EdgeWorker の現在のログ レベルを設定する

顧客が EdgeWorker のログ レベルを設定できるようにします。

使用法: akamai edgeworkers log-level set [options]

オプション	存在	説明
-h、--ヘルプ	オプション	使用状況情報を出力する
--期限切れ	オプション	ユーザーのログレベルの上書きを適用する期間を指定します。この期間を過ぎると、ログ レベルはバンドルで指定されているデフォルトに戻ります。
--ds2Id	オプション	EdgeWorker のbundle.jsonファイルで指定されたものと一緒に使用するデータストリーム ID。

口論	存在	説明
エッジワーカー識別子	必須	ログ レベルを変更する EdgeWorker 識別子。
ネットワーク	必須	新しいログレベルを適用するネットワーク。 「プロダクション」か「ステージング」のどちらかです。
レベル	必須	EdgeWorker に適用する新しいログ レベル。可能な値については、顧客のログ記録ドキュメントを参照してください。

主要な詳細

1. 最後に作成されたログ レベルのオーバーライドのみが有効になります。

2. オーバーライドの有効期限が切れると、ログ レベルは Edgeworker のbundle.jsonファイルで指定されたレベルにリセットされます。

3. コマンドが成功すると、オーバーライドのloggingIdを含むログレベルオーバーライドの詳細が出力されます。 log-level getサブコマンドを使用し、それをlogging-identifierのオプションの引数に渡すことで、 loggingIdを使用してこれらの詳細をいつでも取得できます。

4. --expiresオプションが指定されていない場合、デフォルトではオーバーライドは期限切れになりません。

5. --expiresオプションは、自然言語入力と標準タイムスタンプの両方をサポートします。詳細な仕様については、 chronoパッケージのドキュメントを参照してください。

例

1. 運用ネットワーク上のログ レベル オーバーライドを情報レベルに設定します。このレベルは 1 時間で期限切れになります。

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

2. ステージング ネットワークのログ レベル オーバーライドをトレース レベルに設定します。このレベルは、2024 年 8 月 13 日の午後 3 時 CEST (中央ヨーロッパ夏時間) に期限切れになります。

./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 を開く前に、次の点を再確認してください。

1. PR に添えていくつかのテスト ケースを追加してください。これにより、PR に追加または変更された機能が検証され、コードが機能することが他の人に証明されます :)

2. コードがすべてのコミット前のチェックに合格していることを確認してください。コードは正常にビルドされ、すべての単体テストに合格し、lint の問題がないはずです。

3. すべての PR はマスターではなく開発をターゲットにする必要があります。マスターにマージすると、すぐにすべての顧客にリリースされます。