Beranda>Terkait pemrograman>Kode sumber lainnya
Unduh

CLI EdgeWorker

EdgeWorkers CLI Antarmuka baris perintah (CLI) EdgeWorkers mempercepat proses pendaftaran, pengunggahan, pengaktifan, dan pengujian fungsi EdgeWorkers di jaringan Akamai Edge.

Buka Akamai CLI untuk EdgeKV untuk informasi tentang cara mengelola database EdgeKV dan panggil API EdgeKV dari baris perintah.

Persyaratan Pengaturan Teknis

Untuk menggunakan alat ini, Anda memerlukan:

  • Akamai CLI diinstal.

    • Jika Anda tidak memiliki CLI dan menggunakan Homebrew di Mac, jalankan perintah ini: brew install akamai

    • Anda juga dapat mengunduh biner CLI khusus OS atau image Docker

  • Kredensial EdgeGrid yang valid dikonfigurasi melalui Pusat Kontrol Akamai (lihat Memulai API)

  • Node versi 14 atau lebih tinggi

Instal atau Perbarui EdgeWorkers

  • Jika Anda belum menginstal paket EdgeWorkers CLI, gunakan perintah Akamai CLI berikut untuk menginstal paket EdgeWorkers CLI terbaru:

Penggunaan:
akamai install edgeworkers

  • Jika Anda sudah menginstal CLI, gunakan perintah Akamai CLI berikut untuk menginstal paket EdgeWorkers CLI terbaru yang menyertakan fungsionalitas EdgeKV:

Penggunaan:
akamai update edgeworkers

Berikan Properti Konfigurasi Default

CLI EdgeWorkers memungkinkan Anda menetapkan nilai default untuk opsi perintah. Ada dua cara untuk membuat file konfigurasi:

  1. Buat file konfigurasi ~/.akamai-cli/ew-config , dan simpan properti sebagai berikut:

 [bawaan]
edgeworkerName=testEW
grupId=12345
versionId=1-0-2

  1. Gunakan perintah config untuk menyetel properti default: akamai edgeworkers config set <key> <value>

Nama properti yang tersedia ditampilkan di sini.

Ikhtisar Perintah

EdgeWorkers CLI memungkinkan Anda mengelola fungsi EdgeWorkers dengan memanggil EdgeWorkers API.

Konvensi:

  • argumen opsional []

  • argumen yang diperlukan <>

Penggunaan:
akamai edgeworkers [options] [command]

Pilihan:

Sintaksis Keterangan
-V, --versi Menampilkan nomor versi untuk program EdgeWorkers CLI.
--debug Tampilkan informasi debug.
--edgerc <path> Gunakan kredensial dalam file edgerc untuk perintah. (Lokasi file default adalah ~/.edgerc )
--bagian <name> Gunakan bagian ini di file edgerc . (Bagian default adalah [default] )
--configSection <configSection> Gunakan bagian ini di file ew-config yang berisi kumpulan properti konfigurasi default. (Bagian default adalah [default] )
--waktu habis <timeout> Anda dapat menentukan nilai batas waktu untuk suatu perintah dalam hitungan detik untuk mengganti nilai default 2 menit. Misalnya, jika Anda menambahkan "--timeout 10" ke sebuah perintah, waktu akan habis jika server memerlukan waktu lebih dari 10 detik untuk merespons.
--json [path] Tulis keluaran CLI sebagai JSON ke jalur yang disediakan secara opsional. Jika jalur tidak disediakan, tulis keluaran JSON ke direktori home CLI
--jsonout Tulis keluaran CLI sebagai JSON ke stdout.
-h, --membantu Menampilkan informasi penggunaan untuk EdgeWorkers CLI.

Perintah:

Perintah | Alias Keterangan
bantuan [command] Menampilkan informasi penggunaan untuk perintah yang diberikan.
daftar-grup | lg [group-identifier] Pengembang Pelanggan dapat menemukan tingkat akses EdgeWorkers mereka per Grup Kontrol Akses Luna.
daftar-id | li [options] [edgeworker-identifier] Cantumkan id EdgeWorker yang saat ini terdaftar.
daftar | buat-id <group-identifier> <edgeworker-name> Daftarkan id EdgeWorker baru untuk referensi dalam perilaku Manajer Properti.
pembaruan-id | ui <edgeworker-identifier> <group-identifier> <edgeworker-name> [options] Mengizinkan Pengembang Pelanggan memperbarui atribut Luna ACG atau Nama Pengidentifikasi EdgeWorker yang ada.
hapus-id | hapus-id [options] <edgeworker-identifier> Hapus secara permanen Id EdgeWorker yang ada.
daftar-versi | lv <edgeworker-identifier> [version-identifier] Cantumkan informasi Versi dari Id EdgeWorker tertentu.
unggah | buat versi [options] <edgeworker-identifier> Membuat versi baru dari Id EdgeWorker tertentu yang menyertakan bundel kode.
hapus-versi | hapus versi [options] <edgeworker-identifier> <version-identifier> Hapus secara permanen versi yang ada dari Id EdgeWorker tertentu.
unduh | versi unduhan [options] <edgeworker-identifier> <version-identifier> Unduh bundel kode versi EdgeWorker.
unduh-revisi | dr [options] <edgeworker-identifier> <revision-identifier> Unduh bundel kode gabungan yang berisi kode dan dependensi yang dijalankan EdgeWorker.
status | daftar-aktivasi [options] <edgeworker-identifier> Daftar status Aktivasi dari Id EdgeWorker tertentu.
daftar-revisi | lr [options] <edgeworker-identifier> Cantumkan riwayat revisi untuk ID EdgeWorker tertentu.
dapatkan revisi | gr <edgeworker-identifier> <revision-identifier> Dapatkan detail untuk revisi tertentu.
bandingkan-revisi | cr <edgeworker-identifier> <revision-identifier> <revision-identifier> Lihat perbedaan ketergantungan antara dua revisi EdgeWorker yang sama.
aktifkan-revisi | ar [options] <edgeworker-identifier> <revision-identifier> Aktifkan revisi untuk Id EdgeWorker tertentu di Jaringan Akamai.
pin-revisi [options] <edgeworker-identifier> <revision-identifier> Sematkan revisi aktif untuk ID EdgeWorker tertentu.
lepaskan pin-revisi [options] <edgeworker-identifier> <revision-identifier> Lepas pin revisi aktif yang dipasangi pin untuk ID EdgeWorker tertentu.
dapatkan-revisi-bom | gb [options] <edgeworker-identifier> <revision-identifier> Lihat detail untuk revisi spesifik bundel gabungan.
daftar-revisi-aktivasi | lra [options] <edgeworker-identifier> Cantumkan status Aktivasi Revisi dari ID EdgeWorker yang diberikan.
aktifkan | av <edgeworker-identifier> <network> <versionId> Aktifkan Versi untuk Id EdgeWorker tertentu di Jaringan Akamai.
nonaktifkan | menonaktifkan <edgeworker-identifier> <network> <versionId> Nonaktifkan Versi untuk Id EdgeWorker tertentu di Jaringan Akamai.
memvalidasi | vv <bundlePath> Memvalidasi versi paket kode tanpa mengunggah paket kode.
buat-auth-token | auth [options] <hostName> Menghasilkan token autentikasi yang dapat digunakan untuk mendapatkan header respons debug EdgeWorker yang mendetail. Anda memerlukan setidaknya EdgeWorkers CLI versi 1.7.1 untuk menjalankan perintah ini.
klon | kloning <edgeworker-identifier> <resourceTierId> [options] Mengkloning EdgeWorker dari Id EdgeWorker yang ada.
daftar-kontrak | kontrak-li [options] Daftar id kontrak yang dapat diakses oleh pengguna.
daftar-properti | lp <edgeworker-identifier> [options] Daftar properti yang terkait dengan Id EdgeWorker tertentu.
batas daftar | li-batas Lihat berbagai batasan yang diberlakukan EdgeWorkers pada jumlah aktivasi, ID EdgeWorkers, dan versi yang dapat Anda terapkan.
daftar-restier | li-restier [options] Cantumkan Tingkat Sumber Daya yang dapat digunakan untuk membuat atau mengkloning Id EdgeWorker.
pertunjukan-restier | tampilkan-restier <edgeworker-identifier> Pelanggan bisa mendapatkan detail Tingkat Sumber Daya untuk Id EdgeWorker tertentu.
mendapatkan laporan Dapatkan daftar semua laporan EdgeWorkers yang tersedia.
dapatkan laporan <reportId> <edgeworker-identifier> [options] Dapatkan laporan EdgeWorkers untuk ID EdgeWorker tertentu.
daftar konfigurasi Dapatkan semua nilai dalam file konfigurasi.
konfigurasi dapatkan <key> Dapatkan nilai konfigurasi dari bagian di file konfigurasi.
konfigurasi mengatur <key> <value> Tetapkan nilai konfigurasi di suatu bagian.
konfigurasi simpan -p <properties> Simpan properti konfigurasi di suatu bagian.
konfigurasi tidak disetel <key> Hapus nilai konfigurasi di suatu bagian.

Daftar Grup Izin dengan Akses EdgeWorkers

Pengembang Pelanggan dapat menemukan tingkat akses EdgeWorkers mereka per Grup Kontrol Akses Luna.

Penggunaan: akamai edgeworkers list-groups [options] [group-identifier]

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengenal kelompok opsional Nilai Grup Akses Luna (biasanya angka) untuk memeriksa izin EdgeWorkers

Detail Utama

  1. Output difilter hanya ke Grup Kontrol Akses Luna yang memiliki setidaknya satu kemampuan EdgeWorkers.

  2. Kemampuan dapat berupa: LIHAT,VIEW_VERSION,EDIT,VIEW_ACTIVATION,CREATE_VERSION,ACTIVATE

Cantumkan Pengidentifikasi EdgeWorker yang Ada

Cantumkan id EdgeWorker yang saat ini terdaftar.

Penggunaan: akamai edgeworkers list-ids [options] [edgeworker-identifier]

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--groupId <groupId> Filter daftar Id EdgeWorker berdasarkan Grup Izin
--resourceTierId <resourceTierId> Filter Id EdgeWorker berdasarkan Tingkat Sumber Daya
Argumen Adanya Keterangan
pengidentifikasi edgeworker opsional Pegangan integer unik untuk instance EdgeWorkers

Daftarkan Pengidentifikasi EdgeWorker Baru

Daftarkan id EdgeWorker baru untuk referensi dalam perilaku Manajer Properti.

Penggunaan: akamai edgeworkers register [options] <group-identifier> <edgeworker-name>

Pilihan Keterangan
--resourceTierId Id tingkat Sumber Daya baru yang akan dikaitkan dengan EdgeWorker.
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengenal kelompok diperlukan Nilai Grup Akses Luna (biasanya angka) untuk memeriksa izin EdgeWorkers
nama pekerja tepi diperlukan Label pendek yang dapat dibaca manusia yang menjelaskan instance EdgeWorkers

Detail Utama

  1. Header respons lokasi akan diberikan dengan Id EdgeWorker baru.

  2. Badan respons detail id EdgeWorker (JSON) akan diberikan kode respons 201.

  3. Untuk menonaktifkan perintah untuk tujuan otomatisasi, "resourceTierId" dapat diberikan sebagai masukan.

Perbarui Informasi Pengidentifikasi EdgeWorker

Mengizinkan Pengembang Pelanggan memperbarui atribut Luna ACG atau Nama EdgeWorker Identifier yang ada.

Penggunaan: akamai edgeworkers update-id [options] <edgeworker-identifier> <group-identifier> <edgeworker-name>

Pilihan Keterangan
--resourceTierId Id tingkat Sumber Daya baru yang akan dikaitkan dengan EdgeWorker
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal kelompok diperlukan Nilai Grup Akses Luna (biasanya angka) untuk memeriksa izin EdgeWorkers
nama pekerja tepi diperlukan Label pendek yang dapat dibaca manusia yang menjelaskan instance EdgeWorkers

Detail Utama

  1. API mengharuskan groupId dan nama disediakan meskipun hanya mengubah salah satu atribut ini.

  2. Badan respons detail id EdgeWorker (JSON) akan diberikan 200 kode respons.

  3. ID Tingkat Sumber Daya yang diberikan harus sama dengan yang sudah dimiliki ID EdgeWorker. Untuk memberikan id tingkat sumber daya yang berbeda, silakan gunakan operasi kloning.

Hapus Pengidentifikasi EdgeWorker yang Ada

Hapus secara permanen Pengidentifikasi EdgeWorker yang ada.

Penggunaan: akamai edgeworkers delete-id [options] <edgeworker-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--tidak ada Prompt Lewati perintah konfirmasi penghapusan
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers

Detail Utama

  1. Menghapus ID EdgeWorker hanya dapat dilakukan jika tidak ada versi apa pun yang sedang aktif atau sedang diaktifkan di jaringan Akamai.

  2. Pastikan tidak ada properti aktif yang terkait dengan EdgeWorker sebelum penghapusan.

Daftar Versi EdgeWorker

Cantumkan informasi Versi dari Id EdgeWorker tertentu.

Penggunaan: akamai edgeworkers list-versions [options] <edgeworker-identifier> [version-identifier]

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengidentifikasi versi opsional Pegangan bilangan bulat unik untuk versi instans EdgeWorkers

Detail Utama

  1. Kumpulan hasil diurutkan berdasarkan nilai urutan unggahan yang tidak ditampilkan (bilangan bulat internal yang bertambah).

  2. Versi EdgeWorker adalah string yang ditentukan pelanggan.

Unggah Versi EdgeWorker Baru

Membuat versi baru dari Id EdgeWorker tertentu yang menyertakan bundel kode.

Penggunaan: akamai edgeworkers upload [options] <edgeworker-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--bundel <bundlePath> Jalur ke file bundel dalam format tgz
--codeDir <workingDirectory> Direktori kerja yang mencakup file main.js dan bundle.json
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers

Detail Utama

  1. Salah satu dari --bundle atau --codeDir (tetapi tidak keduanya) harus disediakan.

  2. Jalur dan file kumpulan kode harus ditemukan di sistem file lokal.

  3. --bundle mengharapkan file tgz sudah dibuat sesuai spesifikasi EdgeWorkers.

  4. --codeDir mengharapkan jalur direktori yang berisi main.js (file acara) dan bundle.json (file manifes).

  5. Opsi --codeDir akan memberikan validasi format bundle.json.

  6. --codeDir tidak mengemas direktori atau kode lain selain main.js dan bundle.json.

  7. --codeDir akan membuat file tarball (tgz) jika validasi file berhasil.

  8. Layanan akan membandingkan checksum tarball baru dengan tarball yang diunggah sebelumnya untuk id EdgeWorker yang sama ( ewId ). Jika ditemukan kecocokan, pembuatan versi baru tidak diizinkan.

  9. versionId dibuat oleh pelanggan dan akan ditarik dari bundle.json.

  10. Header respons lokasi akan diberikan id Versi EdgeWorker baru.

  11. Badan respons detail versi EdgeWorker (JSON) akan diberikan kode respons 201.

Hapus Versi EdgeWorker yang Ada

Hapus secara permanen versi yang ada dari Id EdgeWorker tertentu.

Penggunaan: akamai edgeworkers delete-version [options] <edgeworker-identifier> <version-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--tidak ada Prompt Lewati perintah konfirmasi penghapusan
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengidentifikasi versi diperlukan Pegangan bilangan bulat unik untuk versi instans EdgeWorkers

Detail Utama

  1. Menghapus versi hanya dapat dilakukan jika versi tersebut tidak aktif atau sedang diaktifkan di jaringan Akamai.

  2. Jika versi tersebut sedang aktif, versi tersebut harus dinonaktifkan sebelum dapat dihapus.

Unduh Paket Kode EdgeWorkers

Unduh bundel kode versi EdgeWorker.

Penggunaan: akamai edgeworkers download [options] <edgeworker-identifier> <version-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--downloadPath <downloadPath> Jalur untuk menyimpan file bundel yang diunduh; defaultnya adalah direktori home CLI jika tidak disediakan.
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengidentifikasi versi diperlukan Pegangan bilangan bulat unik untuk versi instans EdgeWorkers

Detail Utama

  1. Jika --downloadPath tidak disediakan atau tidak ditemukan pada sistem file lokal, subdirektori cache AkamaiCLI akan digunakan: <CLI_CACHE_PATH>/edgeworkers-cli/edgeworkers/<ewid>/

Unduh Paket Kode Gabungan EdgeWorkers

Unduh bundel kode gabungan yang berisi kode dan dependensi yang dijalankan EdgeWorker.

Penggunaan: akamai edgeworkers download-revision [options] <edgeworker-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--downloadPath <downloadPath> Jalur untuk menyimpan file bundel gabungan yang diunduh; defaultnya adalah direktori home CLI jika tidak disediakan.
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi revisi unik untuk instans EdgeWorkers tertentu

Detail Utama

  1. Jika --downloadPath tidak disediakan atau tidak ditemukan pada sistem file lokal, subdirektori cache AkamaiCLI akan digunakan: <CLI_CACHE_PATH>/edgeworkers-cli/edgeworkers/<revid>/

Cantumkan Status Aktivasi Versi EdgeWorker

Daftar status Aktivasi dari Id EdgeWorker tertentu.

Penggunaan: akamai edgeworkers status [options] <edgeworker-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--versionId <versionId> Pengidentifikasi versi
--activationId <activationId> Pengidentifikasi aktivasi
--aktifDiJaringan Membatasi hasil untuk hanya menampilkan versi yang sedang aktif
--jaringan <network> Membatasi hasil pada versi yang diaktifkan pada jaringan tertentu (STAGING atau PRODUKSI)
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers

Detail Utama

  1. Anda tidak boleh memberikan pengidentifikasi Versi dan Aktivasi.

Daftar Riwayat Revisi EdgeWorker

Cantumkan riwayat revisi untuk ID EdgeWorker tertentu.

Penggunaan: akamai edgeworkers list-revisions [options] <edgeworker-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--versionId <versionId> Pengidentifikasi versi
--activationId <activationId> Pengidentifikasi aktivasi
--hanya disematkan Membatasi hasil untuk hanya menampilkan revisi yang saat ini atau sebelumnya dipasangi pin
--saat iniDipasangi pin Membatasi hasil untuk hanya menampilkan revisi yang sedang dipasangi pin
--jaringan <network> Membatasi hasil pada versi yang diaktifkan pada jaringan tertentu (STAGING atau PRODUKSI)
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers

Detail Utama

  1. Jaringan harus berupa STAGING atau PRODUKSI. Kapitalisasi akan dinormalisasi menjadi huruf besar.

Dapatkan detail Revisi EdgeWorker

Dapatkan detail untuk revisi tertentu.

Penggunaan: akamai edgeworkers get-revision [options] <edgeworker-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi revisi

Bandingkan dua detail Revisi EdgeWorker

Lihat perbedaan ketergantungan antara dua revisi EdgeWorker yang sama.

Penggunaan: akamai edgeworkers compare-revisions [options] <edgeworker-identifier> <revision-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi Revisi Pertama
pengenal revisi diperlukan Pengidentifikasi Revisi Kedua

Detail Utama

  1. Kedua pengidentifikasi revisi tersebut harus berbeda.

Aktifkan Revisi EdgeWorker

Aktifkan revisi untuk ID EdgeWorker tertentu di Jaringan Akamai.

Penggunaan: akamai edgeworkers activate-revision [options] <edgeworker-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--catatan Catatan untuk menjelaskan alasan revisi diaktifkan kembali
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi revisi

Detail Utama

  1. Revisi tersebut akan diaktifkan kembali pada jaringan yang sama (PRODUKSI atau STAGING) yang sebelumnya aktif.

Sematkan Revisi EdgeWorker

Sematkan revisi aktif untuk ID EdgeWorker tertentu.

Penggunaan: akamai edgeworkers pin-revision [options] <edgeworker-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--catatan Catatan untuk menjelaskan alasan revisi tersebut dipasangi pin
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi revisi

Detail Utama

  1. Revisi harus diaktifkan sebelum menyematkan.

Lepas sematan Revisi EdgeWorker

Lepas pin revisi aktif yang dipasangi pin untuk ID EdgeWorker tertentu.

Penggunaan: akamai edgeworkers unpin-revision [options] <edgeworker-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--catatan Catatan untuk menjelaskan alasan revisi tersebut dilepas pinnya
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi revisi

Detail Utama

  1. Revisi harus dipasangi pin sebelum dilepas pinnya.

Dapatkan detail Revisi EdgeWorker

Lihat detail untuk revisi spesifik bundel komposit.

Penggunaan: akamai edgeworkers get-revision-bom [options] <edgeworker-identifier> <revision-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--Versi aktif Batasi hasil untuk hanya menampilkan versi aktif
--saat iniDisematkanRevisi Menampilkan informasi tambahan tentang revisi yang sedang dipasangi pin
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
pengenal revisi diperlukan Pengidentifikasi revisi

Daftar aktivasi Revisi EdgeWorker

Cantumkan status Aktivasi Revisi dari ID EdgeWorker yang diberikan.

Penggunaan: akamai edgeworkers list-revision-activations [options] <edgeworker-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--versionId Pengidentifikasi Versi
--aktivasiId Pengenal Aktivasi
--jaringan Membatasi hasil pada versi yang diaktifkan pada jaringan tertentu (STAGING atau PRODUKSI)
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers

Detail Utama

  1. Anda tidak boleh memberikan pengidentifikasi Versi dan Aktivasi.

  2. Jaringan harus berupa STAGING atau PRODUKSI. Kapitalisasi akan dinormalisasi menjadi huruf besar.

Aktifkan EdgeWorker

Aktifkan Versi untuk Id EdgeWorker tertentu di Jaringan Akamai.

Penggunaan: akamai edgeworkers activate [options] <edgeworker-identifier> <network> <version-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
jaringan diperlukan Label tujuan pengiriman aktivasi Jaringan Akamai (STAGING atau PRODUKSI).
pengidentifikasi versi diperlukan Pegangan bilangan bulat unik untuk versi instans EdgeWorkers

Detail Utama

  1. Jaringan harus berupa STAGING atau PRODUKSI. Kapitalisasi akan dinormalisasi menjadi huruf besar.

  2. Header respons lokasi akan diberikan dengan id Aktivasi EdgeWorker baru.

  3. Badan respons detail aktivasi EdgeWorker (JSON) akan diberikan kode respons 201.

Validasi Paket Kode EdgeWorkers

Memvalidasi versi paket kode tanpa mengunggah paket kode

Penggunaan: akamai edgeworkers validate [options] <bundlePath>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
bundlePath diperlukan Jalur ke file bundel dalam format tgz

Detail Utama

  1. Jalur bundel kode harus ditemukan di sistem file lokal.

  2. Paket kode mengharapkan file tgz sudah dibuat sesuai spesifikasi EdgeWorkers.

Nonaktifkan EdgeWorker

Nonaktifkan Versi untuk Id EdgeWorker tertentu di Jaringan Akamai.

Penggunaan: akamai edgeworkers deactivate [options] <edgeworker-identifier> <network> <version-identifier>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pegangan integer unik untuk instance EdgeWorkers
jaringan diperlukan Label tujuan pengiriman aktivasi Jaringan Akamai (STAGING atau PRODUKSI).
pengidentifikasi versi diperlukan Pegangan bilangan bulat unik untuk versi instans EdgeWorkers

Detail Utama

  1. Jaringan harus berupa STAGING atau PRODUKSI. Kapitalisasi akan dinormalisasi menjadi huruf besar.

  2. Header respons lokasi akan diberikan dengan id Aktivasi EdgeWorker baru.

  3. Badan respons detail aktivasi EdgeWorker (JSON) akan diberikan kode respons 201.

Buat Token Otentikasi EdgeWorkers

Menghasilkan token autentikasi yang dapat digunakan untuk mendapatkan header respons debug EdgeWorker yang mendetail. Anda memerlukan setidaknya EdgeWorkers CLI versi 1.7.1 untuk menjalankan perintah ini. Gunakan opsi -V, --version untuk menampilkan nomor versi EdgeWorkers CLI saat ini.

Penggunaan: akamai edgeworkers create-auth-token [options] <hostName>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--kedaluwarsa <expiry> Durasi kedaluwarsa token, dalam hitungan menit.
--format <format> Format keluaran yang akan dicetak
Argumen Adanya Keterangan
nama host opsional Nama Host properti. Jika tidak ada nama host yang diberikan maka token dibuat untuk semua host ( /* ) di bawah properti. Misalnya: www.test.com, www.test1.com

Detail Utama

  1. Nilai --expiry harus antara 1 dan 720 menit (12 jam). Standarnya adalah 8 hours .

Kloning Id EdgeWorker

Memungkinkan pelanggan mengkloning EdgeWorker dari Id EdgeWorker yang ada.

Penggunaan: akamai edgeworkers clone <edgeworker-identifier> <resourceTierId> [options]

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--Nama baru Nama EdgeWorker
--groupId Pengidentifikasi grup
Argumen Adanya Keterangan
resourceTierId diperlukan Id tingkat sumber daya tempat EdgeWorker akan dikloning.

Detail Utama

  1. Titik akhir ini memungkinkan pengguna untuk memilih ID Tingkat Sumber Daya yang berbeda untuk id EdgeWorker tertentu dengan mengkloningnya. Mengkloning ke tingkat sumber daya yang sama akan gagal.

Daftar Kontrak

Daftar id kontrak yang dapat diakses oleh pengguna.

Penggunaan: akamai list-contracts

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran

Daftar Properti

Daftar properti yang terkait dengan Id EdgeWorker tertentu.

Penggunaan: akamai edgeworkers list-properties <edgeworker-identifier> [options]

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
--hanya aktif Hanya mengembalikan properti aktif
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pengidentifikasi EdgeWorker.

Detail Utama

  1. Perhatikan bahwa boolean limitedAccessToProperties yang dikembalikan adalah true jika pengguna tidak memiliki akses ke grup tingkat teratas pada akun tersebut, atau jika mereka tidak memiliki peran admin untuk grup ini.

Batas Daftar

Cantumkan berbagai batasan yang diberlakukan EdgeWorkers pada jumlah aktivasi, ID EdgeWorkers, dan versi yang dapat Anda terapkan.

Penggunaan: akamai edgeworkers list-limits [options]

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran

Cantumkan Tingkat Sumber Daya untuk ID Kontrak tertentu

Cantumkan Tingkat Sumber Daya yang dapat digunakan untuk membuat atau mengkloning ID EdgeWorker.

Penggunaan: akamai list-restiers

Pilihan Keterangan
--kontrakId Tingkat sumber daya untuk id kontrak yang ditentukan.
-h, --membantu informasi penggunaan keluaran

Detail Utama

  1. Pengguna akan diminta dengan daftar id kontrak yang dapat diakses oleh pengguna. Id kontrak yang dipilih akan digunakan untuk mengambil tingkat sumber daya.

  2. Untuk menonaktifkan prompt untuk tujuan otomatisasi, id kontrak dapat diberikan sebagai masukan.

Ambil Tingkat Sumber Daya untuk Id EdgeWorker tertentu

Pelanggan bisa mendapatkan detail Tingkat Sumber Daya untuk Id EdgeWorker tertentu.

Penggunaan: akamai show-restier <edgeworkerId>

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran
Argumen Adanya Keterangan
edgeworkerId diperlukan Pengidentifikasi EdgeWorker

Dapatkan Jenis Laporan EdgeWorkers yang Tersedia

Cantumkan jenis laporan yang tersedia yang dapat dibuat untuk ID EdgeWorker.

Penggunaan: akamai get reports

Pilihan Keterangan
-h, --membantu informasi penggunaan keluaran

Detail Utama

  1. Pengguna akan diberikan tabel dengan ID laporan dan deskripsi setiap laporan. Gunakan reportId tertentu dengan perintah get report untuk mendapatkan laporan untuk EdgeWorker tertentu.

Dapatkan Laporan EdgeWorker

Dapatkan laporan untuk ID EdgeWorker tertentu.

Penggunaan: akamai get report <reportId> <edgeworker-identifier>

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
-s, --tanggal mulai <startDate> diperlukan Stempel waktu ISO 8601 yang menunjukkan waktu mulai laporan EdgeWorkers.
-e, --tanggal akhir <startDate> opsional Stempel waktu ISO 8601 yang menunjukkan waktu berakhirnya laporan EdgeWorkers. Jika tidak ditentukan, waktu akhir akan ditetapkan secara default ke waktu saat ini.
--status <status> opsional String yang dipisahkan koma untuk difilter berdasarkan status EdgeWorkers. Nilai: success , genericError , unknownEdgeWorkerId , unimplementedEventHandler , runtimeError , executionError , timeoutError , resourceLimitHit , cpuTimeoutError , wallTimeoutError , initCpuTimeoutError , initWallTimeoutError .
--ev, --eventHandlers <eventHandlers> opsional String yang dipisahkan koma untuk memfilter EdgeWorkers berdasarkan peristiwa yang memicunya. Nilai: onClientRequest , onOriginRequest , onOriginResponse , onClientResponse , responseProvider .
Argumen Adanya Keterangan
laporanId diperlukan Jenis Laporan.
pengidentifikasi edgeworker diperlukan Pengidentifikasi EdgeWorker.

Detail Utama

  1. Untuk daftar ID laporan yang tersedia, gunakan perintah get reports .

  2. Opsi startDate adalah opsi yang diperlukan.

Cantumkan Semua Nilai Default Bagian di File Konfigurasi

Dapatkan semua properti default di bagian file konfigurasi.

Penggunaan: akamai config list

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran

Detail Utama

  1. Bagian konfigurasi default secara default. Untuk menggunakan bagian yang berbeda, pengguna harus menentukan perintah akamai edgeworkers dengan opsi --configSection <configSeciont> .

  2. Pendekatan yang sama harus diterapkan pada perintah config berikut.

Dapatkan Nilai Default Bagian di File Konfigurasi

Dapatkan satu nilai default tertentu di bagian file konfigurasi.

Penggunaan: akamai config get <key>

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
Argumen Adanya Keterangan
kunci diperlukan Nama properti default

Tetapkan/Perbarui Nilai Default Bagian di File Konfigurasi

Memungkinkan pelanggan mengatur/memperbarui nilai default tertentu di bagian file konfigurasi.

Penggunaan: akamai config set <key> <value>

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
Argumen Adanya Keterangan
kunci diperlukan Nama properti default
nilai diperlukan Nilai properti default

Hapus Nilai Default Bagian di File Konfigurasi

Memungkinkan pelanggan menghapus nilai default tertentu di bagian file konfigurasi.

Penggunaan: akamai config unset <key>

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
Argumen Adanya Keterangan
kunci diperlukan Nama properti default

Simpan Secara Massal Properti Default Bagian di File Konfigurasi

Memungkinkan pelanggan menyimpan nilai default secara massal.

Penggunaan: akamai config save [options]

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
-p, --properti diperlukan Konfigurasi properti. Gunakan format 'key=value' untuk menyetel properti dan spasi untuk memisahkannya.

Detail Utama

  1. Jika konteksnya berisi item yang tidak valid, perintah akan melewatkan item tersebut dan melanjutkan.

Lihat tingkat pencatatan saat ini untuk EdgeWorker

Memungkinkan pelanggan melihat detail penggantian tingkat logging untuk edgeworker.

Penggunaan: akamai edgeworkers log-level get [options] <edgeworker-identifier> [logging-identifier]

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pengidentifikasi EdgeWorker untuk menampilkan informasi penggantian tingkat logging.
pengenal logging opsional ID logging dari tingkat logging yang akan ditampilkan.

Detail Utama

  1. Jika logging-identifier tidak ditentukan, semua penggantian tingkat logging akan ditampilkan.

  2. logging-identifier adalah konstanta numerik, yang mengidentifikasi penggantian tingkat log. Hal ini dapat diperoleh selama pembuatan override, atau dengan membuat daftar semua override tanpa memberikan argumen opsional dan mencari bidang loggingId override tertentu.

Tetapkan tingkat pencatatan saat ini untuk EdgeWorker

Memungkinkan pelanggan mengatur tingkat logging untuk EdgeWorker.

Penggunaan: akamai edgeworkers log-level set [options] <edgeworker-identifier> <network> <level>

Pilihan Adanya Keterangan
-h, --membantu opsional informasi penggunaan keluaran
--kedaluwarsa opsional Menentukan berapa lama penggantian tingkat logging pengguna akan diterapkan. Setelah melewatinya, tingkat logging kembali ke default yang ditentukan dalam bundel.
--ds2Id opsional ID aliran data yang akan digunakan bersama dengan yang ditentukan dalam file bundle.json EdgeWorker.
Argumen Adanya Keterangan
pengidentifikasi edgeworker diperlukan Pengidentifikasi EdgeWorker untuk mengubah tingkat logging.
jaringan diperlukan Jaringan yang akan menerapkan tingkat logging baru. Entah "produksi" atau "pementasan".
tingkat diperlukan Tingkat logging baru untuk diterapkan pada EdgeWorker. Untuk kemungkinan nilai, lihat dokumentasi pencatatan pelanggan.

Detail Utama

  1. Hanya penggantian tingkat log yang paling baru dibuat yang berlaku.

  2. Ketika override berakhir, tingkat logging diatur ulang ke tingkat yang ditentukan dalam file bundle.json Edgeworker.

  3. Jika perintah berhasil, detail penggantian tingkat log akan dicetak, yang mencakup loggingId dari penggantian tersebut. loggingId dapat digunakan untuk mendapatkan detail ini kapan saja dengan menggunakan subperintah log-level get dan meneruskannya ke argumen opsional logging-identifier .

  4. Jika opsi --expires tidak ditentukan, defaultnya adalah override tidak pernah kedaluwarsa.

  5. Opsi --expires mendukung masukan bahasa alami dan stempel waktu standar. Silakan merujuk ke dokumentasi paket chrono untuk spesifikasi lengkap.

Contoh

  1. Setel penggantian tingkat log pada jaringan produksi ke tingkat info, yang akan habis masa berlakunya dalam 1 jam. 

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

  1. Tetapkan penggantian tingkat log pada jaringan staging ke tingkat pelacakan, yang akan berakhir pada pukul 15.00 CEST (Waktu Musim Panas Eropa Tengah) pada tanggal 13 Agustus 2024. 

./akamai-edgeworkers log-level set 654321 staging trace --expires "2024-08-13T15:00+02:00"

Sumber daya

Untuk informasi selengkapnya tentang EdgeWorkers, lihat sumber daya berikut:

  • Halaman Pengembang EdgeWorkers

  • Panduan Pengguna EdgeWorkers

  • Panduan API EdgeWorkers

Masalah Pelaporan

Anda sudah siap, selamat coding! Jika Anda mengalami masalah apa pun dengan EdgeWorkers CLI, sampaikan masalah tersebut sebagai masalah github. Jangan ragu untuk membuat permintaan tarik dengan perbaikan atau saran.

Berkontribusi

Kami menerima kontribusi dari staf Akamai, pelanggan, atau pihak lain. Sebelum membuka PR harap periksa kembali hal-hal berikut:

  1. Silakan tambahkan beberapa test case untuk menemani PR Anda. Ini memverifikasi fungsionalitas yang ditambahkan atau dimodifikasi dalam PR dan membuktikan kepada orang lain bahwa kode Anda berfungsi :)

  2. Harap pastikan bahwa kode Anda melewati semua pemeriksaan pra-komitmen. Kode Anda seharusnya berhasil dibuat, lulus semua pengujian unit, dan tidak memiliki masalah linting.

  3. Semua PR harus menargetkan pengembangan, bukan master. Penggabungan ke master akan segera dirilis ke semua pelanggan.

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua