Mengkueri daftar eksekusi dan status perintah Asisten Cloud.
Deskripsi operasi
-
Setelah Anda menjalankan perintah, perintah tersebut belum tentu berhasil dijalankan atau menghasilkan hasil yang diharapkan. Anda perlu memeriksa hasil eksekusi aktual dengan melihat nilai kembalian dari operasi ini. Output aktual menjadi acuan utama.
-
Anda dapat mengkueri informasi eksekusi dari 30 hari terakhir. Maksimal 10.000 catatan eksekusi disimpan.
-
Anda dapat berlangganan event status tugas Asisten Cloud untuk memperoleh hasil tugas melalui event, sehingga menghindari polling berulang dan meningkatkan efisiensi.
-
Saat mengkueri halaman pertama dari kueri berhalaman, tetapkan hanya
MaxResultsuntuk membatasi jumlah entri yang dikembalikan. NilaiNextTokendalam tanggapan berfungsi sebagai kredensial untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, tetapkan parameterNextTokenke nilaiNextTokenyang diperoleh dari tanggapan sebelumnya, dan tetapkanMaxResultsuntuk membatasi jumlah entri yang dikembalikan. -
Perbedaan antara
DescribeInvocationsdanDescribeInvocationResults:- Ketika satu panggilan
RunCommand/InvokeCommandmenentukan beberapa instans:DescribeInvocationsmengembalikan status eksekusi pada setiap instans dan status agregat di seluruh beberapa instans.DescribeInvocationResultshanya mengembalikan status eksekusi individu pada setiap instans, tanpa status agregat di seluruh beberapa instans.
- Ketika satu panggilan
RunCommand/InvokeCommandmenentukan satu instans:DescribeInvocationsdanDescribeInvocationResultssebagian besar dapat saling menggantikan.
Ketika Anda perlu melihat riwayat eksekusi Tugas terjadwal (periode) atau Tugas yang dieksekusi otomatis saat Instans dimulai (
RepeatMode=Period, EveryReboot), hanyaDescribeInvocationResultsyang dapat mengembalikan catatan eksekusi historis (Anda harus menentukanIncludeHistory=true).DescribeInvocationshanya mengembalikan status Tugas terbaru.Ketika Anda perlu melihat konten perintah dan parameter, hanya
DescribeInvocationsyang mengembalikanCommandContent.
- Ketika satu panggilan
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeInvocations |
get |
Instans.
Command.
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru. |
cn-hangzhou |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya tempat eksekusi perintah berada. Setelah Anda menentukan parameter ini, hasil eksekusi perintah difilter berdasarkan ResourceGroupId yang ditentukan saat perintah dijalankan. |
rg-bp67acfmxazb4p**** |
| InvokeId |
string |
No |
ID eksekusi perintah. |
t-hz0jdfwd9f**** |
| CommandId |
string |
No |
ID perintah. Anda dapat memanggil DescribeCommands untuk mengkueri semua ID perintah yang tersedia. |
c-hz0jdfwcsr**** |
| CommandName |
string |
No |
Nama perintah. Parameter ini tidak berlaku jika Anda juga menentukan |
CommandTestName |
| CommandType |
string |
No |
Tipe perintah. Nilai valid:
|
RunShellScript |
| Timed |
boolean |
No |
Apakah perintah akan dijalankan secara otomatis di masa depan. Nilai valid:
Nilai default: false. |
true |
| InvokeStatus |
string |
No |
Status eksekusi keseluruhan perintah. Status eksekusi keseluruhan bergantung pada status eksekusi umum di satu atau lebih instans dalam eksekusi. Nilai valid:
|
Finished |
| InstanceId |
string |
No |
ID instans. Jika Anda menentukan parameter ini, semua catatan eksekusi perintah untuk instans tersebut akan dikueri. |
i-bp1i7gg30r52z2em**** |
| ContentEncoding |
string |
No |
Mode pengkodean bidang
Nilai default: Base64. |
PlainText |
| IncludeOutput |
boolean |
No |
Apakah akan mengembalikan output perintah dalam hasil.
Nilai default: false. |
false |
| PageNumber |
integer |
No |
Catatan
Parameter ini akan segera didepresiasi. Gunakan NextToken dan MaxResults untuk menyelesaikan operasi kueri berhalaman. |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini akan segera didepresiasi. Gunakan NextToken dan MaxResults untuk menyelesaikan operasi kueri berhalaman. |
10 |
| MaxResults |
integer |
No |
Jumlah maksimum entri per halaman untuk kueri berhalaman. Nilai maksimum: 50. Nilai default: 10. |
10 |
| NextToken |
string |
No |
Token paginasi. Tetapkan parameter ini ke nilai NextToken yang dikembalikan dalam panggilan API sebelumnya. |
AAAAAdDWBF2 |
| RepeatMode |
string |
No |
Mode eksekusi perintah. Parameter ini tidak berlaku jika Anda juga menentukan
Nilai default: kosong, yang menunjukkan bahwa semua mode eksekusi dikueri. |
Once |
| Tag |
array<object> |
No |
Tag. |
|
|
object |
No |
Tag. |
||
| Value |
string |
No |
Nilai tag eksekusi perintah. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong.
Panjang nilai tag maksimal 128 karakter dan tidak boleh mengandung |
TestValue |
| Key |
string |
No |
Kunci tag eksekusi perintah. Nilai valid N: 1 hingga 20. Kunci tag tidak boleh berupa string kosong. Jika Anda menggunakan satu tag untuk memfilter Sumber daya, jumlah resource dengan tag ini tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter Sumber daya, jumlah resource dengan semua tag yang ditentukan terlampir tidak boleh melebihi 1.000. Jika jumlah resource melebihi 1.000, gunakan operasi ListTagResources untuk melaksanakan kueri. Panjang kunci tag maksimal 64 karakter dan tidak boleh dimulai dengan |
TestKey |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| PageSize |
integer |
Jumlah entri per halaman. |
10 |
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| PageNumber |
integer |
Nomor halaman hasil kueri. |
1 |
| TotalCount |
integer |
Jumlah total perintah. |
1 |
| NextToken |
string |
Token paginasi yang dikembalikan dalam panggilan ini. |
AAAAAdDWBF2 |
| Invocations |
object |
||
| Invocation |
array<object> |
Catatan eksekusi perintah. |
|
|
array<object> |
Pengatur waktu saat Tugas dibuat. |
||
| OssOutputDelivery |
string |
Konfigurasi pengiriman OSS untuk output eksekusi perintah. |
oss://testBucket/testPrefix |
| InvocationStatus |
string |
Status eksekusi keseluruhan perintah. Status eksekusi keseluruhan bergantung pada status eksekusi umum di semua instans dalam panggilan ini. Nilai valid:
Catatan
Parameter respons |
Running |
| Parameters |
string |
Parameter kustom dalam perintah. |
{} |
| Timed |
boolean |
Apakah perintah akan dijalankan secara otomatis di masa mendatang. |
false |
| CommandDescription |
string |
Deskripsi perintah. |
skrip uji |
| Timeout |
integer |
Periode pengatur waktu maksimum untuk eksekusi perintah pada Instans ECS. Unit: detik. Jika perintah tidak dapat dijalankan karena alasan tertentu, terjadi timeout. Saat terjadi timeout, proses perintah dihentikan secara paksa dengan membatalkan PID perintah. |
60 |
| InvokeInstances |
object |
||
| InvokeInstance |
array<object> |
Tipe set instans target. |
|
|
object |
Daftar status eksekusi. |
||
| Dropped |
integer |
Panjang teks yang dipotong dan dibuang setelah teks dalam bidang Output melebihi 24 KB. |
0 |
| InvocationStatus |
string |
Status eksekusi perintah pada satu instans. Nilai valid:
|
Success |
| InstanceId |
string |
ID instans. |
i-bp1i7gg30r52z2em**** |
| Timed |
boolean |
Apakah perintah akan dijalankan secara otomatis di masa mendatang. |
false |
| InstanceInvokeStatus |
string |
Status eksekusi perintah pada satu instans. Catatan
Kami menyarankan Anda memeriksa parameter |
Finished |
| ExitCode |
integer |
Kode keluar proses perintah. Nilai valid:
|
0 |
| ErrorInfo |
string |
Detail kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai valid:
|
Instans yang ditentukan tidak ada |
| StartTime |
string |
Waktu saat perintah mulai dijalankan pada instans. |
2019-12-20T06:15:55Z |
| Repeats |
integer |
Jumlah kali perintah dijalankan pada instans.
|
0 |
| OssOutputUri |
string |
URI file OSS tempat output eksekusi perintah dikirim. Bidang ini adalah string kosong ketika pengiriman gagal atau sedang berlangsung. |
oss://testBucket/testPrefix/output.txt |
| OssOutputStatus |
string |
Status pengiriman output eksekusi perintah. Nilai valid:
|
Finished |
| OssOutputErrorCode |
string |
Kode kesalahan saat pengiriman gagal. Bidang ini hanya dikembalikan ketika OssOutputStatus adalah Failed. Nilai valid:
|
CloudAssistant.UnsupportedInvocationStatus |
| OssOutputErrorInfo |
string |
Detail kesalahan saat pengiriman gagal. Bidang ini hanya dikembalikan ketika OssOutputStatus adalah Failed. |
The invocation status does not support output delivery |
| FinishTime |
string |
Waktu akhir proses perintah. |
2019-12-20T06:15:56Z |
| Output |
string |
Output perintah.
|
OutPutTestmsg |
| CreationTime |
string |
Waktu mulai eksekusi perintah. |
2019-12-20T06:15:54Z |
| UpdateTime |
string |
Waktu saat status perintah diperbarui. |
2020-01-19T09:15:47Z |
| ErrorCode |
string |
Kode kesalahan untuk kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai valid:
|
InstanceNotExists |
| StopTime |
string |
Waktu saat |
2020-01-19T09:15:47Z |
| CommandContent |
string |
Konten perintah.
|
cnBtIC1xYSB8IGdyZXAgdnNm**** |
| WorkingDir |
string |
Direktori kerja eksekusi perintah. |
/home/ |
| RepeatMode |
string |
Mode eksekusi perintah. Nilai valid:
|
Once |
| InvokeStatus |
string |
Status eksekusi keseluruhan perintah. Catatan
Kami menyarankan Anda memeriksa parameter |
Finished |
| CommandType |
string |
Tipe perintah. |
RunShellScript |
| Username |
string |
Nama pengguna yang digunakan untuk menjalankan perintah pada Instans ECS. |
test |
| ContainerId |
string |
ID kontainer. |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
Nama kontainer. |
test-Kontainer |
| CreationTime |
string |
Pengatur waktu saat Tugas dibuat. |
2020-01-19T09:15:46Z |
| Frequency |
string |
Jadwal untuk eksekusi perintah terjadwal. |
0 */20 * * * * |
| Launcher |
string |
Launcher untuk eksekusi skrip. Panjang launcher tidak boleh melebihi 1 KB. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| CommandId |
string |
ID perintah. |
c-hz0jdfwcsr**** |
| CommandName |
string |
Nama perintah. |
CommandTestName |
| InvokeId |
string |
ID eksekusi perintah. |
t-hz0jdfwd9f**** |
| TerminationMode |
string |
Mode yang digunakan saat Tugas dihentikan (dihentikan secara manual atau terganggu karena waktu habis). Nilai valid:
|
ProcessTree |
| Tags |
object |
||
| Tag |
array<object> |
Informasi tag eksekusi perintah. |
|
|
object |
Informasi tag eksekusi perintah. |
||
| TagKey |
string |
Kunci tag eksekusi perintah. |
pemilik |
| TagValue |
string |
Nilai tag eksekusi perintah. |
zhangsan |
Contoh
Respons sukses
JSONformat
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2",
"Invocations": {
"Invocation": [
{
"OssOutputDelivery": "oss://testBucket/testPrefix",
"InvocationStatus": "Running",
"Parameters": "{}",
"Timed": false,
"CommandDescription": "testDescription",
"Timeout": 60,
"InvokeInstances": {
"InvokeInstance": [
{
"Dropped": 0,
"InvocationStatus": "Success",
"InstanceId": "i-bp1i7gg30r52z2em****",
"Timed": false,
"InstanceInvokeStatus": "Finished",
"ExitCode": 0,
"ErrorInfo": "the specified instance does not exists",
"StartTime": "2019-12-20T06:15:55Z",
"Repeats": 0,
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"OssOutputStatus": "Finished",
"OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
"OssOutputErrorInfo": "The invocation status does not support output delivery.",
"FinishTime": "2019-12-20T06:15:56Z",
"Output": "OutPutTestmsg",
"CreationTime": "2019-12-20T06:15:54Z",
"UpdateTime": "2020-01-19T09:15:47Z",
"ErrorCode": "InstanceNotExists",
"StopTime": "2020-01-19T09:15:47Z"
}
]
},
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"WorkingDir": "/home/",
"RepeatMode": "Once",
"InvokeStatus": "Finished",
"CommandType": "RunShellScript",
"Username": "test",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"CreationTime": "2020-01-19T09:15:46Z",
"Frequency": "0 */20 * * * *",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"CommandId": "c-hz0jdfwcsr****",
"CommandName": "CommandTestName",
"InvokeId": "t-hz0jdfwd9f****",
"TerminationMode": "ProcessTree",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
}
]
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | Pemanggilan API tidak didukung di wilayah tertentu. Periksa apakah nilai parameter RegionId benar. |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | Jumlah tag melebihi batas maksimum. Anda dapat mengoperasikan maksimal 20 tag per operasi. |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | Terdapat kunci duplikat dalam tag. Pastikan semua kunci unik. |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | Parameter kunci tag yang ditentukan tidak valid. |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | Parameter nilai tag yang ditentukan tidak valid. |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | Tentukan kunci tag. |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | Parameter MaxResults yang ditentukan tidak valid. |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | Terjadi kesalahan saat mengirim permintaan. Coba lagi nanti. |
| 403 | Operation.Forbidden | The operation is not permitted. | Operasi tidak diizinkan. |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | RegionId yang ditentukan tidak ada. Periksa apakah produk tersedia di wilayah ini. |
| 404 | InvalidCommandId.NotFound | The specified commandId does not exist |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.