Mengkueri daftar eksekusi dan status perintah Asisten Cloud.
Deskripsi operasi
-
Setelah Anda menjalankan perintah, perintah tersebut tidak selalu berhasil dijalankan atau menghasilkan hasil yang diharapkan. Anda harus memeriksa hasil eksekusi aktual berdasarkan nilai kembalian operasi ini. Output aktual yang diutamakan.
-
Anda dapat mengkueri informasi eksekusi dari 30 hari terakhir. Maksimal 10.000 catatan eksekusi disimpan.
-
Anda dapat berlangganan event status Tugas Asisten Cloud untuk mendapatkan hasil Tugas melalui event, yang menghindari polling berulang dan meningkatkan efisiensi.
-
Saat melakukan kueri halaman pertama, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken dalam tanggapan berfungsi sebagai token untuk mengkueri halaman berikutnya. Saat melakukan kueri halaman berikutnya, tetapkan NextToken ke nilai NextToken yang diperoleh dari tanggapan sebelumnya dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan.
-
Perbedaan antara
DescribeInvocationsdanDescribeInvocationResults:- Saat satu panggilan
RunCommand/InvokeCommandmenentukan beberapa instans:DescribeInvocationsmengembalikan status eksekusi pada setiap instans dan status agregat di seluruh instans.DescribeInvocationResultshanya mengembalikan status eksekusi individual pada setiap instans, tanpa status agregat.
- Saat satu panggilan
RunCommand/InvokeCommandmenentukan satu instans:DescribeInvocationsdanDescribeInvocationResultssebagian besar dapat dipertukarkan.
Untuk Tampilan detail eksekusi setiap jalanan untuk Tugas terjadwal (periode) atau Tugas yang dipicu saat boot (
RepeatMode=Period, EveryReboot), hanyaDescribeInvocationResultsyang dapat mengembalikan catatan eksekusi historis (denganIncludeHistory=trueditentukan).DescribeInvocationshanya mengembalikan status Tugas terbaru.Untuk Tampilan konten dan parameter perintah, hanya
DescribeInvocationsyang mengembalikanCommandContent.
- Saat satu panggilan
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeInvocations |
get |
Instance
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 untuk eksekusi perintah. Setelah Anda menentukan parameter ini, ID kelompok sumber daya juga harus ditentukan saat Anda menjalankan perintah. Parameter ini memfilter hasil eksekusi perintah yang sesuai. |
rg-bp67acfmxazb4p**** |
| InvokeId |
string |
No |
ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru. |
t-hz0jdfwd9f**** |
| CommandId |
string |
No |
ID eksekusi perintah. |
c-hz0jdfwcsr**** |
| CommandName |
string |
No |
ID perintah. Anda dapat memanggil DescribeCommands untuk mengkueri semua ID perintah yang tersedia. |
CommandTestName |
| CommandType |
string |
No |
Nama perintah. Parameter ini tidak berlaku jika Anda juga menentukan InstanceId. |
RunShellScript |
| Timed |
boolean |
No |
Tipe perintah. Nilai valid:
|
true |
| InvokeStatus |
string |
No |
Apakah akan menjalankan perintah yang dikueri secara otomatis di masa mendatang. Nilai valid:
Nilai default: false. |
Finished |
| InstanceId |
string |
No |
Status eksekusi keseluruhan perintah. Status eksekusi keseluruhan ditentukan oleh status eksekusi gabungan di satu atau beberapa instans. Nilai valid:
|
i-bp1i7gg30r52z2em**** |
| ContentEncoding |
string |
No |
ID instans. Jika Anda menentukan parameter ini, semua catatan eksekusi perintah untuk instans tersebut akan dikueri. |
PlainText |
| IncludeOutput |
boolean |
No |
Mode pengodean bidang CommandContent dan Output dalam tanggapan. Nilai valid:
Nilai default: Base64. |
false |
| PageNumber |
integer |
No |
Apakah akan mengembalikan output perintah dalam hasil.
Nilai default: false. |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini akan segera dihentikan penggunaannya. Gunakan NextToken dan MaxResults untuk menyelesaikan operasi paging. |
10 |
| MaxResults |
integer |
No |
Catatan
Parameter ini akan segera dihentikan penggunaannya. Gunakan NextToken dan MaxResults untuk menyelesaikan operasi paging. |
10 |
| NextToken |
string |
No |
Jumlah entri maksimum per halaman untuk paging. Nilai maksimum: 50. Nilai default: 10. |
AAAAAdDWBF2 |
| RepeatMode |
string |
No |
Token pagination. Tetapkan parameter ini ke nilai NextToken yang dikembalikan dalam panggilan API sebelumnya. |
Once |
| Tag |
array<object> |
No |
Mode eksekusi perintah. Parameter ini tidak berlaku jika Anda juga menentukan InstanceId. Nilai valid:
Nilai default: kosong, yang menunjukkan bahwa semua mode eksekusi dikueri. |
|
|
object |
No |
Tag. |
||
| Value |
string |
No |
Nilai tag eksekusi perintah. Nilai N yang valid: 1 hingga 20. Nilai tag dapat berupa string kosong.
Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung |
TestValue |
| Key |
string |
No |
Kunci tag eksekusi perintah. Nilai N yang valid: 1 hingga 20. Kunci tag tidak boleh berupa string kosong. Jika Anda menggunakan satu tag untuk memfilter sumber daya, jumlah sumber daya dengan tag yang ditentukan tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya dengan semua tag yang ditentukan terlampir tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, panggil ListTagResources untuk menjalankan kueri. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh dimulai dengan |
TestKey |
|
No |
Tag. |
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 pagination 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 yang valid:
Catatan
Parameter respons |
Running |
| Parameters |
string |
Parameter kustom dalam perintah. |
{} |
| Timed |
boolean |
Menunjukkan apakah perintah akan dijalankan secara otomatis di masa mendatang. |
false |
| CommandDescription |
string |
Deskripsi perintah. |
testDescription |
| Timeout |
integer |
Periode batas waktu maksimum untuk eksekusi perintah pada instans ECS. Unit: detik. Jika perintah tidak dapat dijalankan karena alasan apa pun, batas waktu akan terjadi. Ketika batas waktu terjadi, 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 yang valid:
|
Success |
| InstanceId |
string |
ID instans. |
i-bp1i7gg30r52z2em**** |
| Timed |
boolean |
Menunjukkan apakah perintah akan dijalankan secara otomatis di masa mendatang. |
false |
| InstanceInvokeStatus |
string |
Status eksekusi perintah pada satu instans. Catatan
Kami menyarankan Anda untuk memeriksa parameter |
Finished |
| ExitCode |
integer |
Kode keluar proses perintah. Nilai yang valid:
|
0 |
| ErrorInfo |
string |
Detail kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai yang valid:
|
the specified instance does not exists |
| 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 dikirimkan. Bidang ini berupa string kosong ketika pengiriman gagal atau sedang berlangsung. |
oss://testBucket/testPrefix/output.txt |
| OssOutputStatus |
string |
Status pengiriman output eksekusi perintah. Nilai yang valid:
|
Finished |
| OssOutputErrorCode |
string |
Kode kesalahan ketika pengiriman gagal. Bidang ini hanya dikembalikan ketika OssOutputStatus adalah Failed. Nilai yang valid:
|
CloudAssistant.UnsupportedInvocationStatus |
| OssOutputErrorInfo |
string |
Detail kesalahan ketika pengiriman gagal. Bidang ini hanya dikembalikan ketika OssOutputStatus adalah Failed. |
The invocation status does not support output delivery. |
| FinishTime |
string |
Waktu berakhirnya 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 yang 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 yang valid:
|
Once |
| InvokeStatus |
string |
Status eksekusi keseluruhan perintah. Catatan
Kami menyarankan Anda untuk memeriksa parameter |
Finished |
| CommandType |
string |
Jenis 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-container |
| CreationTime |
string |
Waktu saat tugas dibuat. |
2020-01-19T09:15:46Z |
| Frequency |
string |
Jadwal untuk eksekusi perintah terjadwal. |
0 */20 * * * * |
| Launcher |
string |
Peluncur untuk eksekusi skrip. Peluncur tidak boleh melebihi panjang 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 untuk menghentikan tugas (penghentian manual atau interupsi batas waktu). Nilai yang valid:
|
ProcessTree |
| Tags |
object |
||
| Tag |
array<object> |
Informasi tag eksekusi perintah. |
|
|
object |
Informasi tag eksekusi perintah. |
||
| TagKey |
string |
Kunci tag eksekusi perintah. |
owner |
| 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. | |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | |
| 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. | |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | |
| 403 | Operation.Forbidden | The operation is not permitted. | |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.