Elastic Compute Service:RunCommand

ID wilayah. Anda dapat memanggil DescribeRegions untuk menanyakan daftar terbaru wilayah Alibaba Cloud.

ID grup sumber daya untuk eksekusi perintah. Ketika parameter ini ditentukan:

• Jika instans ECS yang sesuai dengan InstanceId termasuk dalam grup sumber daya non-default, instans ECS harus termasuk dalam grup sumber daya ini.

• Anda dapat memfilter hasil eksekusi perintah yang sesuai dengan menentukan parameter ini (dengan memanggil DescribeInvocations atau DescribeInvocationResults).

ID wilayah. Anda dapat memanggil DescribeRegions untuk menanyakan daftar terbaru wilayah Alibaba Cloud.

Nama perintah. Mendukung set karakter lengkap. Panjangnya tidak boleh melebihi 128 karakter.

Deskripsi perintah. Mendukung set karakter lengkap. Panjangnya tidak boleh melebihi 512 karakter.

Jenis perintah. Nilai yang valid:

• RunBatScript: Perintah Bat untuk instans Windows.

• RunPowerShellScript: Perintah PowerShell untuk instans Windows.

• RunShellScript: Perintah Shell untuk instans Linux.

Konten perintah. Konten perintah dapat berupa teks biasa atau konten yang dikodekan Base64. Perhatikan hal-hal berikut:

• Jika perintah disimpan, konten perintah setelah pengkodean Base64 tidak boleh melebihi 18 KB. Jika perintah tidak disimpan, konten perintah setelah pengkodean Base64 tidak boleh melebihi 24 KB. Anda dapat mengatur apakah akan menyimpan perintah melalui KeepCommand.

• Jika konten perintah Anda dikodekan Base64, Anda harus mengatur ContentEncoding=Base64.

• Mengatur EnableParameter=true mengaktifkan fitur parameter kustom dalam konten perintah:

  • Tentukan parameter kustom dengan mengapitnya dalam {{}}. Spasi dan jeda baris sebelum dan sesudah nama parameter dalam {{}} akan diabaikan.

  • Jumlah parameter kustom tidak boleh melebihi 20.

  • Nama parameter kustom hanya dapat berisi kombinasi a-zA-Z0-9-_. Awalan acs:: untuk menentukan parameter lingkungan non-bawaan tidak didukung, dan karakter lain tidak didukung. Nama parameter tidak peka huruf besar-kecil.

  • Satu nama parameter kustom tidak boleh melebihi 64 byte.

• Anda dapat menentukan parameter lingkungan bawaan sebagai parameter kustom. Saat menjalankan perintah, Anda tidak perlu memberikan nilai secara manual ke parameter; Cloud Assistant akan secara otomatis menggantinya dengan nilai yang sesuai dari lingkungan. Parameter lingkungan bawaan berikut didukung:

  • {{ACS::RegionId}}: ID Wilayah.

  • {{ACS::AccountId}}: UID akun utama Alibaba Cloud.

  • {{ACS::InstanceId}}: ID Instans. Ketika perintah dikirim ke beberapa instans, jika Anda perlu menentukan {{ACS::InstanceId}} sebagai parameter lingkungan bawaan, pastikan versi Cloud Assistant Agent tidak lebih rendah dari berikut:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::InstanceName}}: Nama Instans. Ketika perintah dikirim ke beberapa instans, jika Anda perlu menentukan {{ACS::InstanceName}} sebagai parameter lingkungan bawaan, pastikan versi Cloud Assistant Agent tidak lebih rendah dari berikut:

    • Linux: 2.2.3.344

    • Windows: 2.1.3.344

  • {{ACS::InvokeId}}: ID eksekusi perintah. Jika Anda perlu menentukan {{ACS::InvokeId}} sebagai parameter lingkungan bawaan, pastikan versi Cloud Assistant Agent tidak lebih rendah dari berikut:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::CommandId}}: ID Perintah. Ketika menjalankan perintah melalui API ini, jika Anda perlu menentukan {{ACS::CommandId}} sebagai parameter lingkungan bawaan, pastikan versi Cloud Assistant Agent tidak lebih rendah dari berikut:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

Direktori kerja perintah pada instans ECS. Panjangnya tidak boleh melebihi 200 karakter.

Nilai default:

• Untuk instans Linux, defaultnya adalah direktori beranda administrator (pengguna root), yaitu /root.

• Untuk instans Windows, defaultnya adalah direktori tempat proses Cloud Assistant Agent berada, misalnya C:\Windows\System32.

Periode batas waktu untuk menjalankan perintah, dalam detik.

Ketika perintah tidak dapat berjalan karena masalah proses, modul yang hilang, Cloud Assistant Agent yang hilang, atau alasan lainnya, batas waktu akan terjadi. Setelah batas waktu, proses perintah akan dihentikan secara paksa.

Nilai default: 60.

Menentukan apakah perintah berisi parameter kustom.

Nilai default: false.

Mengatur mode eksekusi perintah. Nilai yang valid:

• Once: Jalankan perintah segera.

• Period: Jalankan perintah sesuai jadwal. Ketika parameter ini diatur ke Period, Anda juga harus menentukan parameter Frequency.

• NextRebootOnly: Secara otomatis menjalankan perintah saat instans berikutnya dinyalakan.

• EveryReboot: Secara otomatis menjalankan perintah setiap kali instans dinyalakan.

• DryRun: Hanya melakukan pra-pemeriksaan permintaan ini. Eksekusi perintah tidak akan benar-benar berlaku. Item pra-pemeriksaan meliputi parameter permintaan, lingkungan eksekusi instans, status berjalan Cloud Assistant Agent, dll.

Nilai default:

• Ketika parameter Frequency tidak ditentukan, nilai defaultnya adalah Once.

• Ketika parameter Frequency ditentukan, perintah akan diproses sebagai Period terlepas dari apakah nilai parameter ini telah diatur.

Catatan:

• Anda dapat memanggil StopInvocation untuk menghentikan perintah yang tertunda atau perintah terjadwal.

• Ketika parameter ini diatur ke Period atau EveryReboot, Anda dapat memanggil DescribeInvocationResults dan menentukan IncludeHistory=true untuk melihat riwayat eksekusi perintah terjadwal.

Waktu eksekusi untuk eksekusi perintah terjadwal. Saat ini, tiga jenis eksekusi terjadwal didukung: eksekusi interval tetap (berdasarkan ekspresi Rate), eksekusi satu kali pada waktu tertentu, dan eksekusi terjadwal berbasis jam (berdasarkan ekspresi Cron).

• Eksekusi interval tetap: Berdasarkan ekspresi Rate, perintah dijalankan pada interval waktu yang ditentukan. Satuan interval waktu yang didukung meliputi detik (s), menit (m), jam (h), dan hari (d), cocok untuk skenario di mana tugas perlu dijalankan pada interval waktu tetap. Format: rate(<nilai interval><satuan interval>). Misalnya, untuk menjalankan setiap 5 menit, formatnya adalah rate(5m). Eksekusi interval tetap memiliki batasan berikut:

  • Interval waktu yang ditetapkan tidak boleh melebihi 7 hari atau kurang dari 60 detik, dan harus lebih besar dari periode batas waktu tugas terjadwal.

  • Interval eksekusi hanya berdasarkan frekuensi tetap dan tidak terkait dengan waktu aktual yang dibutuhkan untuk eksekusi tugas. Misalnya, jika Anda mengatur perintah untuk dijalankan setiap 5 menit dan tugas membutuhkan 2 menit untuk selesai, putaran berikutnya akan berlanjut 3 menit setelah tugas selesai.

  • Tugas tidak akan dijalankan segera setelah dibuat. Misalnya, jika Anda mengatur perintah untuk dijalankan setiap 5 menit, perintah tidak akan dijalankan segera saat tugas dibuat, tetapi akan mulai dijalankan 5 menit setelah pembuatan tugas.

• Eksekusi satu kali pada waktu tertentu: Jalankan perintah sekali pada zona waktu dan titik waktu eksekusi yang ditetapkan. Format: at(yyyy-MM-dd HH:mm:ss <zona waktu>), yaitu at(tahun-bulan-tanggal jam:menit:detik <zona waktu>). Jika zona waktu tidak ditentukan, defaultnya adalah UTC. Zona waktu mendukung tiga format berikut:

  • Nama zona waktu lengkap: Seperti Asia/Shanghai (waktu Tiongkok/Shanghai), America/Los_Angeles (waktu AS/Los Angeles), dll.

  • Offset zona waktu dari Greenwich Mean Time: Seperti GMT+8:00 (Zona Delapan Timur), GMT-7:00 (Zona Tujuh Barat), dll. Saat menggunakan format GMT, angka nol di depan pada posisi jam tidak didukung.

  • Singkatan zona waktu: Hanya UTC (Waktu Universal Terkoordinasi) yang didukung.

  Misalnya, untuk menjalankan sekali pada pukul 13:15:30 tanggal 6 Juni 2022 dalam waktu Tiongkok/Shanghai, formatnya adalah: at(2022-06-06 13:15:30 Asia/Shanghai); untuk menjalankan sekali pada pukul 13:15:30 tanggal 6 Juni 2022 di Zona Tujuh Barat, formatnya adalah: at(2022-06-06 13:15:30 GMT-7:00).

• Eksekusi terjadwal berbasis jam (berdasarkan ekspresi Cron): Berdasarkan ekspresi Cron, perintah dijalankan sesuai dengan tugas terjadwal yang ditetapkan. Format: <detik> <menit> <jam> <hari dalam bulan> <bulan> <hari dalam minggu> <tahun (opsional)> <zona waktu>, yaitu <ekspresi Cron> <zona waktu>. Di bawah zona waktu yang ditentukan, waktu eksekusi tugas terjadwal dihitung berdasarkan ekspresi Cron. Jika zona waktu tidak ditentukan, defaultnya adalah zona waktu internal sistem instans yang menjalankan tugas terjadwal. Untuk informasi lebih lanjut tentang ekspresi Cron, lihat Ekspresi Cron. Zona waktu mendukung tiga format berikut:

  • Nama zona waktu lengkap: Seperti Asia/Shanghai (waktu Tiongkok/Shanghai), America/Los_Angeles (waktu AS/Los Angeles), dll.

  • Offset zona waktu dari Greenwich Mean Time: Seperti GMT+8:00 (Zona Delapan Timur), GMT-7:00 (Zona Tujuh Barat), dll. Saat menggunakan format GMT, angka nol di depan pada posisi jam tidak didukung.

  • Singkatan zona waktu: Hanya UTC (Waktu Universal Terkoordinasi) yang didukung. Misalnya, dalam waktu Tiongkok/Shanghai, untuk menjalankan sekali setiap hari pada pukul 10:15 pagi di tahun 2022, formatnya adalah 0 15 10 ? * * 2022 Asia/Shanghai; dalam waktu Zona Delapan Timur, untuk menjalankan setiap setengah jam dari pukul 10:00 hingga 11:30 setiap hari di tahun 2022, formatnya adalah 0 0/30 10-11 * * ? 2022 GMT+8:00; dalam waktu UTC, mulai dari 2022, setiap dua tahun di bulan Oktober, untuk menjalankan setiap 5 menit dari pukul 14:00 hingga 14:55 setiap hari, formatnya adalah 0 0/5 14 * 10 ? 2022/2 UTC.

  Catatan

  Interval waktu minimum yang ditetapkan harus lebih besar dari atau sama dengan periode batas waktu tugas terjadwal, dan tidak boleh kurang dari 10 detik.

Pasangan kunci-nilai parameter kustom yang diteruskan saat menjalankan perintah yang berisi parameter kustom. Misalnya, jika konten perintah adalah echo {{name}}, Anda dapat meneruskan pasangan kunci-nilai {"name":"Jack"} melalui parameter Parameter. Parameter kustom akan secara otomatis menggantikan nilai variabel name, menghasilkan perintah baru yang benar-benar menjalankan echo Jack.

Jumlah parameter kustom berkisar dari 0 hingga 10. Perhatikan hal-hal berikut:

• Kunci tidak boleh berupa string kosong dan mendukung maksimum 64 karakter.

• Nilai dapat berupa string kosong.

• Setelah pengkodean Base64 dari parameter kustom dan konten perintah asli, jika perintah disimpan, konten perintah setelah pengkodean Base64 tidak boleh melebihi 18 KB; jika perintah tidak disimpan, konten perintah setelah pengkodean Base64 tidak boleh melebihi 24 KB. Anda dapat mengatur apakah akan menyimpan perintah melalui KeepCommand.

• Kumpulan nama parameter kustom harus merupakan subset dari kumpulan parameter yang didefinisikan saat membuat perintah. Untuk parameter yang tidak diteruskan, Anda dapat menggunakan string kosong sebagai pengganti.

Nilai default: kosong, menunjukkan bahwa parameter ini dibatalkan untuk menonaktifkan parameter kustom.

Menentukan apakah akan menyimpan perintah setelah eksekusi. Nilai yang valid:

• true: Simpan. Perintah dapat dijalankan kembali melalui InvokeCommand. Ini akan dihitung terhadap kuota penyimpanan perintah Cloud Assistant.

• false: Jangan simpan. Perintah akan otomatis dihapus setelah eksekusi dan tidak akan dihitung terhadap kuota penyimpanan perintah Cloud Assistant.

Nilai default: false.

Metode pengkodean konten perintah (CommandContent). Nilai yang valid (tidak peka huruf besar-kecil):

• PlainText: Tanpa pengkodean, dikirim dalam teks biasa.

• Base64: Pengkodean Base64.

Nilai default: PlainText. Nilai yang tidak valid atau salah akan diperlakukan sebagai PlainText.

Nama pengguna untuk menjalankan perintah pada instans ECS. Panjangnya tidak boleh melebihi 255 karakter.

• Untuk instans ECS Linux, perintah dijalankan sebagai pengguna root secara default.

• Untuk instans ECS Windows, perintah dijalankan sebagai pengguna System secara default.

Anda juga dapat menentukan pengguna lain yang sudah ada pada instans untuk menjalankan perintah. Menjalankan perintah Cloud Assistant sebagai pengguna biasa lebih aman. Untuk informasi lebih lanjut, lihat Mengatur pengguna biasa untuk menjalankan perintah Cloud Assistant.

Nama kata sandi pengguna yang menjalankan perintah pada instans Windows. Panjangnya tidak boleh melebihi 255 karakter.

Ketika Anda ingin menjalankan perintah pada instans Windows sebagai pengguna non-default (System), Anda perlu meneruskan Username dan parameter ini. Untuk mengurangi risiko kebocoran kata sandi, kata sandi teks biasa perlu dihosting di penyimpanan parameter Systems Manager, dan hanya nama kata sandi yang diteruskan di sini. Untuk informasi lebih lanjut, lihat Parameter enkripsi dan Mengatur pengguna biasa untuk menjalankan perintah Cloud Assistant.

ID kontainer. Hanya string heksadesimal 64-bit yang didukung. Awalan docker://, containerd://, atau cri-o:// diizinkan untuk secara eksplisit menentukan runtime kontainer.

Catatan:

• Jika parameter ini ditentukan, Cloud Assistant akan menjalankan skrip di dalam kontainer yang ditentukan pada instans.

• Jika parameter ini ditentukan, hanya didukung pada instans Linux dengan Cloud Assistant Agent versi 2.2.3.344 atau yang lebih baru.

• Jika parameter ini ditentukan, parameter Username dan WorkingDir yang ditentukan tidak akan berlaku. Hanya pengguna default kontainer di direktori kerja default kontainer yang didukung untuk eksekusi perintah. Untuk informasi lebih lanjut, lihat Menggunakan Cloud Assistant untuk menjalankan perintah di kontainer.

Nama kontainer.

Catatan:

• Jika parameter ini ditentukan, Cloud Assistant akan menjalankan skrip di dalam kontainer yang ditentukan pada instans.

• Jika parameter ini ditentukan, hanya didukung pada instans Linux dengan Cloud Assistant Agent versi 2.2.3.344 atau yang lebih baru.

• Jika parameter ini ditentukan, parameter Username dan WorkingDir yang ditentukan tidak akan berlaku. Hanya pengguna default kontainer di direktori kerja default kontainer yang didukung untuk eksekusi perintah. Untuk informasi lebih lanjut, lihat Menggunakan Cloud Assistant untuk menjalankan perintah di kontainer.

Memastikan idempotensi permintaan. Buat nilai parameter dari klien Anda untuk memastikan keunikan di seluruh permintaan yang berbeda. ClientToken hanya mendukung karakter ASCII dan tidak boleh melebihi 64 karakter. Untuk informasi lebih lanjut, lihat Cara memastikan idempotensi.

Konfigurasi pengiriman output eksekusi perintah ke OSS.

• Format: oss://${BucketName}/${Prefix}, di mana ${BucketName} adalah nama bucket OSS tujuan pengiriman, dan ${Prefix} adalah awalan direktori tujuan pengiriman.

Mode saat menghentikan tugas (penghentian manual atau interupsi batas waktu eksekusi). Nilai yang valid:

• Process: Hentikan proses skrip saat ini.

• ProcessTree: Hentikan pohon proses saat ini (kumpulan proses skrip dan semua proses anak yang dibuatnya).

Program bootstrap untuk eksekusi skrip. Panjangnya tidak boleh melebihi 1 KB.