Elastic Compute Service:InvokeCommand

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

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

• Jika instans ECS yang ditentukan oleh InstanceId termasuk dalam grup sumber daya non-default, instans ECS tersebut harus termasuk dalam grup sumber daya ini.

• Anda dapat menggunakan parameter ini untuk memfilter hasil eksekusi perintah (dengan memanggil DescribeInvocations atau DescribeInvocationResults).

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

ID perintah. Anda dapat memanggil DescribeCommands untuk mengkueri semua CommandId yang tersedia.

Menentukan cara perintah dijalankan. Nilai yang valid:

• Once: menjalankan perintah segera.

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

• NextRebootOnly: menjalankan perintah secara otomatis pada saat instans dijalankan berikutnya.

• EveryReboot: menjalankan perintah secara otomatis setiap kali instans dijalankan.

• DryRun: hanya melakukan pemeriksaan awal terhadap permintaan ini. Perintah tidak akan benar-benar dijalankan. Item pemeriksaan mencakup parameter permintaan, lingkungan runtime instans, status Cloud Assistant Agent, dan sebagainya.

Nilai default:

• Jika parameter Frequency tidak ditentukan, nilai default-nya adalah Once.

• Jika parameter Frequency ditentukan, nilainya diproses sebagai Period terlepas dari apa yang diatur untuk parameter ini.

Catatan:

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

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

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

• Eksekusi interval waktu tetap: Berdasarkan ekspresi Rate, perintah dijalankan pada interval waktu yang dikonfigurasi. Interval mendukung pemilihan berdasarkan detik (s), menit (m), jam (h), dan hari (d). Metode ini cocok untuk skenario di mana tugas dijalankan pada interval tetap. Formatnya adalah rate(<interval-value><interval-unit>). Misalnya, untuk menjalankan sekali setiap 5 menit, gunakan rate(5m). Batasan eksekusi interval waktu tetap:

  • Interval harus tidak lebih dari 7 hari, tidak kurang dari 60 detik, dan lebih besar dari waktu habis tugas terjadwal.

  • Interval eksekusi didasarkan pada frekuensi tetap dan tidak tergantung pada waktu yang sebenarnya diperlukan untuk menjalankan tugas. Misalnya, jika Anda mengatur perintah untuk berjalan setiap 5 menit dan tugas membutuhkan waktu 2 menit untuk selesai, eksekusi berikutnya dimulai 3 menit setelah tugas selesai.

  • Perintah tidak dijalankan segera saat tugas dibuat. Misalnya, jika Anda mengatur perintah untuk berjalan setiap 5 menit, perintah tidak berjalan segera setelah dibuat; sebaliknya, eksekusi pertama dimulai 5 menit setelah tugas dibuat.

• Eksekusi hanya sekali pada waktu tertentu: Perintah dijalankan sekali pada zona waktu dan waktu yang dikonfigurasi. Formatnya adalah at(yyyy-MM-dd HH:mm:ss <time-zone>), yaitu at(tahun-bulan-tanggal jam:menit:detik <zona-waktu>). Jika tidak ada zona waktu yang ditentukan, default-nya adalah UTC. Zona waktu mendukung tiga bentuk berikut:

  • Nama zona waktu lengkap: seperti Asia/Shanghai (waktu China/Shanghai), America/Los_Angeles (waktu Amerika Serikat/Los Angeles), dll.

  • Offset zona waktu relatif terhadap GMT: seperti GMT+8:00 (UTC+8), GMT-7:00 (UTC-7), dll. Ketika menggunakan format GMT, angka nol di depan tidak didukung pada bidang jam.

  • Singkatan zona waktu: hanya UTC (Coordinated Universal Time) yang didukung.

  Untuk menjalankan sekali pada 13:15:30 pada tanggal 6 Juni 2022 dalam waktu China/Shanghai, gunakan: at(2022-06-06 13:15:30 Asia/Shanghai). Untuk menjalankan sekali pada 13:15:30 pada tanggal 6 Juni 2022 dalam UTC-7, gunakan: 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 dikonfigurasi. Formatnya adalah <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 dari ekspresi Cron dan dijalankan. Jika tidak ada zona waktu yang ditentukan, default-nya adalah zona waktu sistem internal dari instans yang menjalankan tugas terjadwal. Untuk informasi lebih lanjut tentang ekspresi Cron, lihat Ekspresi Cron. Zona waktu mendukung tiga bentuk berikut:

  • Nama zona waktu lengkap: seperti Asia/Shanghai (waktu China/Shanghai), America/Los_Angeles (waktu Amerika Serikat/Los Angeles), dll.

  • Offset zona waktu relatif terhadap GMT: seperti GMT+8:00 (UTC+8), GMT-7:00 (UTC-7), dll. Ketika menggunakan format GMT, angka nol di depan tidak didukung pada bidang jam.

  • Singkatan zona waktu: hanya UTC (Coordinated Universal Time) yang didukung. Misalnya, untuk menjalankan perintah sekali pada pukul 10:15 setiap hari pada tahun 2022 dalam waktu China/Shanghai, gunakan 0 15 10 ? * * 2022 Asia/Shanghai; untuk menjalankan setiap setengah jam dari 10:00 hingga 11:30 setiap hari pada tahun 2022 dalam UTC+8, gunakan 0 0/30 10-11 * * ? 2022 GMT+8:00; untuk menjalankan setiap 5 menit dari 14:00 hingga 14:55 setiap hari pada bulan Oktober setiap dua tahun mulai dari 2022 dalam UTC, gunakan 0 0/5 14 * 10 ? 2022/2 UTC.

  Catatan

  Interval waktu minimum yang dikonfigurasi harus lebih besar dari atau sama dengan waktu habis tugas terjadwal dan tidak kurang dari 10 detik.

Pasangan key-value dari parameter kustom yang diteruskan saat perintah dijalankan, jika fitur parameter kustom diaktifkan. Jumlah parameter kustom berkisar antara 0 hingga 10.

• Kunci map tidak boleh berupa string kosong dan dapat memiliki panjang hingga 64 karakter.

• Nilai map dapat berupa string kosong.

• Panjang gabungan parameter kustom dan konten perintah asli tidak boleh melebihi 18 KB setelah penyandian Base64.

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

Anda dapat membiarkan parameter ini tidak diatur untuk menonaktifkan fitur parameter kustom.

Nama pengguna yang digunakan untuk menjalankan perintah pada instans ECS. Panjang nama pengguna tidak boleh melebihi 255 karakter.

• Untuk instans ECS Linux, pengguna default adalah root.

• Untuk instans ECS Windows, pengguna default adalah System.

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

Nama kata sandi yang digunakan untuk menjalankan perintah pada instans Windows. Panjang nama kata sandi tidak boleh melebihi 255 karakter.

Ketika Anda ingin menjalankan perintah pada instans Windows sebagai pengguna non-default (selain System), Anda perlu meneruskan Username dan parameter ini. Untuk mengurangi risiko pengungkapan kata sandi, kata sandi harus di-host dalam bentuk teks biasa di penyimpanan parameter Operation Orchestration Service. Di sini, hanya nama kata sandi yang diteruskan. Untuk informasi lebih lanjut, lihat Parameter enkripsi dan Jalankan perintah Cloud Assistant sebagai pengguna biasa.

ID kontainer. Hanya string heksadesimal 64-bit yang didukung. Anda dapat menggunakan awalan docker://, containerd://, atau cri-o:// untuk menentukan runtime kontainer.

Catatan:

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

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

  • Untuk informasi tentang cara melihat versi Cloud Assistant Agent, lihat Instal Cloud Assistant Agent.

  • Untuk informasi tentang cara meningkatkan versi Cloud Assistant Agent, lihat Tingkatkan atau nonaktifkan peningkatan Cloud Assistant Agent.

• Jika parameter ini ditentukan, parameter Username yang ditentukan dalam API ini dan parameter WorkingDir yang ditentukan dalam CreateCommand tidak berlaku. Perintah hanya dapat dijalankan oleh pengguna kontainer default di direktori kerja default kontainer. Untuk informasi lebih lanjut, lihat Gunakan Cloud Assistant untuk menjalankan perintah di kontainer.

• Jika parameter ini ditentukan, hanya skrip shell yang dapat dijalankan di kontainer Linux, dan Anda tidak dapat menentukan penerjemah konten skrip menggunakan pernyataan seperti #!/usr/bin/python di awal skrip. Untuk informasi lebih lanjut, lihat Gunakan Cloud Assistant untuk menjalankan perintah di kontainer.

Nama kontainer.

Catatan:

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

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

  • Untuk informasi tentang cara melihat versi Cloud Assistant Agent, lihat Instal Cloud Assistant Agent.

  • Untuk informasi tentang cara meningkatkan versi Cloud Assistant Agent, lihat Tingkatkan atau nonaktifkan peningkatan Cloud Assistant Agent.

• Jika parameter ini ditentukan, parameter Username yang ditentukan dalam API ini dan parameter WorkingDir yang ditentukan dalam CreateCommand tidak berlaku. Perintah hanya dapat dijalankan oleh pengguna kontainer default di direktori kerja default kontainer. Untuk informasi lebih lanjut, lihat Gunakan Cloud Assistant untuk menjalankan perintah di kontainer.

• Jika parameter ini ditentukan, hanya skrip shell yang dapat dijalankan di kontainer Linux, dan Anda tidak dapat menentukan penerjemah konten skrip menggunakan pernyataan seperti #!/usr/bin/python di awal skrip. Untuk informasi lebih lanjut, lihat Gunakan Cloud Assistant untuk menjalankan perintah di kontainer.

Periode waktu habis untuk eksekusi perintah, dalam detik.

• Nilai ini tidak boleh kurang dari 10 detik.

• Jika perintah tidak dapat dijalankan karena masalah proses, modul yang hilang, atau Cloud Assistant Agent yang hilang, perintah akan habis waktu. Setelah waktu habis, proses perintah dihentikan secara paksa.

• Jika nilai ini tidak diatur, waktu habis yang ditentukan saat perintah dibuat akan digunakan.

• Nilai ini hanya digunakan sebagai waktu habis untuk eksekusi perintah ini dan tidak mengubah waktu habis dari perintah itu sendiri.

Token klien yang digunakan untuk memastikan idempoten permintaan. Hasilkan nilai dari klien Anda untuk memastikan bahwa nilai ini unik di antara permintaan yang berbeda. ClientToken hanya mendukung karakter ASCII dan tidak boleh melebihi 64 karakter. Untuk informasi lebih lanjut, lihat Cara memastikan idempoten.

Mode yang digunakan untuk menghentikan tugas (penghentian manual atau gangguan ketika eksekusi habis waktu). Nilai yang valid:

• Process: menghentikan proses skrip saat ini.

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

Bootstrap untuk eksekusi skrip. Panjang tidak boleh melebihi 1 KB.

Direktori tempat perintah dijalankan pada instans ECS. Panjang direktori tidak boleh melebihi 200 karakter.

• Jika nilai ini tidak diatur, direktori yang dijalankan yang ditentukan saat perintah dibuat akan digunakan.

• Nilai ini hanya digunakan sebagai direktori yang dijalankan untuk eksekusi perintah ini dan tidak mengubah direktori yang dijalankan dari perintah itu sendiri.

Konfigurasi pengiriman OSS untuk output eksekusi perintah.

• Format: oss://${BucketName}/${Prefix}, di mana ${BucketName} adalah nama bucket OSS yang akan dikirim dan ${Prefix} adalah prefiks direktori yang akan dikirim.