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. Periksa hasil eksekusi aktual berdasarkan nilai kembalian dari 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, menghindari polling yang sering, dan meningkatkan efisiensi.
-
Saat mengkueri halaman pertama dari kueri halaman, atur hanya
MaxResultsuntuk membatasi jumlah entri yang dikembalikan. NilaiNextTokendalam tanggapan berfungsi sebagai kredensial untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, atur parameterNextTokenke nilaiNextTokenyang diperoleh dari tanggapan sebelumnya, dan aturMaxResultsuntuk membatasi jumlah entri yang dikembalikan. -
Perbedaan antara
DescribeInvocationsdanDescribeInvocationResults:- Saat satu panggilan
RunCommand/InvokeCommandmenentukan beberapa instans:DescribeInvocationsmengembalikan status eksekusi pada setiap instans dan status agregasi di seluruh instans.DescribeInvocationResultshanya mengembalikan status eksekusi individual pada setiap instans, tanpa status agregasi di beberapa instans.
- Saat satu panggilan
RunCommand/InvokeCommandmenentukan satu instans:DescribeInvocationsdanDescribeInvocationResultssebagian besar dapat dipertukarkan dan dapat saling menggantikan.
Untuk Tampilan riwayat eksekusi Tugas terjadwal (periode) atau Tugas yang dieksekusi secara otomatis saat instans dimulai (
RepeatMode=Period, EveryReboot), hanyaDescribeInvocationResultsyang dapat mengambil catatan eksekusi sebelumnya (dengan menentukanIncludeHistory=true).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, Anda juga harus menentukan ResourceGroupId saat perintah Berjalan. Parameter ini memfilter hasil eksekusi perintah yang sesuai. |
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 parameter |
CommandTestName |
| CommandType |
string |
No |
Tipe perintah. Nilai valid:
|
RunShellScript |
| Timed |
boolean |
No |
Apakah akan menjalankan perintah yang dikueri secara otomatis di masa mendatang. Nilai valid:
Nilai default: false. |
true |
| InvokeStatus |
string |
No |
Status eksekusi keseluruhan perintah. Status eksekusi keseluruhan bergantung pada status eksekusi umum dari satu atau beberapa instans dalam eksekusi. Nilai valid:
|
Finished |
| InstanceId |
string |
No |
ID instans. Jika Anda menentukan parameter ini, semua catatan eksekusi perintah untuk instans akan dikueri. |
i-bp1i7gg30r52z2em**** |
| ContentEncoding |
string |
No |
Mode pengodean 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 ditinggalkan. Gunakan NextToken dan MaxResults untuk melakukan operasi kueri halaman. |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini akan segera ditinggalkan. Gunakan NextToken dan MaxResults untuk melakukan operasi kueri halaman. |
10 |
| MaxResults |
integer |
No |
Jumlah entri maksimum per halaman untuk kueri halaman. Nilai maksimum: 50. Nilai default: 10. |
10 |
| NextToken |
string |
No |
Token halaman. Atur parameter ini ke nilai NextToken yang dikembalikan dalam panggilan API sebelumnya. |
AAAAAdDWBF2 |
| RepeatMode |
string |
No |
Mode eksekusi perintah. Parameter ini tidak berlaku jika parameter
Nilai default: kosong, yang menunjukkan bahwa semua mode eksekusi dikueri. |
Once |
| Tag |
array<object> |
No |
Tag. |
|
|
object |
No |
Tag. |
||
| Key |
string |
No |
Kunci tag dari 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 Sumber daya dengan tag ini tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter Sumber daya, jumlah Sumber daya dengan semua tag yang ditentukan terpasang tidak boleh melebihi 1.000. Jika jumlah Sumber daya melebihi 1.000, panggil ListTagResources untuk mengeksekusi kueri. Panjang kunci tag dapat mencapai 64 karakter dan tidak boleh diawali dengan |
TestKey |
| Value |
string |
No |
Nilai tag dari eksekusi perintah. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong.
Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh mengandung |
TestValue |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| Invocations |
object |
||
| Invocation |
array<object> |
Catatan eksekusi perintah. |
|
|
array<object> |
Waktu saat Tugas dibuat. |
||
| CommandContent |
string |
Konten perintah.
|
cnBtIC1xYSB8IGdyZXAgdnNm**** |
| CommandDescription |
string |
Deskripsi perintah. |
testSkrip |
| CommandId |
string |
ID perintah. |
c-hz0jdfwcsr**** |
| CommandName |
string |
Nama perintah. |
CommandTestName |
| CommandType |
string |
Tipe perintah. |
RunShellScript |
| ContainerId |
string |
ID kontainer. |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
Nama kontainer. |
test-Kontainer |
| CreationTime |
string |
Waktu saat Tugas dibuat. Waktu ditampilkan dalam format ISO 8601 dalam UTC. |
2020-01-19T09:15:46Z |
| Frequency |
string |
Jadwal saat perintah dijalankan. |
0 */20 * * * * |
| InvocationStatus |
string |
Status eksekusi keseluruhan perintah. Status eksekusi keseluruhan bergantung pada status eksekusi umum dari semua instans dalam pemanggilan ini. Nilai valid:
Catatan
Parameter respons InvokeStatus memiliki arti yang serupa, tetapi kami menyarankan Anda memeriksa parameter ini sebagai gantinya. |
Running |
| InvokeId |
string |
ID eksekusi perintah. |
t-hz0jdfwd9f**** |
| InvokeInstances |
object |
||
| InvokeInstance |
array<object> |
Tipe set instans target untuk eksekusi. |
|
|
object |
Daftar status eksekusi. |
||
| CreationTime |
string |
Waktu saat eksekusi perintah dimulai. Waktu ditampilkan dalam format ISO 8601 dalam UTC. |
2019-12-20T06:15:54Z |
| Dropped |
integer |
Panjang teks yang dipotong dan dibuang setelah teks dalam bidang Output melebihi 24 KB. |
0 |
| ErrorCode |
string |
Kode kesalahan untuk kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai valid:
|
InstanceNotExists |
| ErrorInfo |
string |
Alasan mendetail untuk kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai valid:
|
instans yang ditentukan tidak ada |
| ExitCode |
integer |
Kode keluar dari proses perintah. Nilai valid:
|
0 |
| FinishTime |
string |
Waktu saat proses perintah berakhir. Waktu ditampilkan dalam format ISO 8601 dalam UTC. |
2019-12-20T06:15:56Z |
| InstanceId |
string |
ID instans. |
i-bp1i7gg30r52z2em**** |
| InstanceInvokeStatus |
string |
Status eksekusi perintah pada satu instans. Catatan
Kami menyarankan Anda memeriksa parameter respons InvocationStatus sebagai ganti parameter ini. |
Finished |
| InvocationStatus |
string |
Status eksekusi perintah pada satu instans. Nilai valid:
|
Success |
| OssOutputErrorCode |
string |
Kode kesalahan saat pengiriman gagal. Parameter ini hanya dikembalikan ketika OssOutputStatus adalah Failed. Nilai valid:
|
CloudAssistant.UnsupportedInvocationStatus |
| OssOutputErrorInfo |
string |
Detail error saat pengiriman gagal. Parameter ini hanya dikembalikan ketika OssOutputStatus adalah Failed. |
The invocation status does not support output delivery |
| OssOutputStatus |
string |
Status pengiriman output eksekusi perintah ke OSS. Nilai valid:
|
Finished |
| OssOutputUri |
string |
URI file di OSS tempat output eksekusi perintah dikirim. Bidang ini berupa string kosong saat pengiriman gagal atau sedang berlangsung. |
oss://testBucket/testPrefix/output.txt |
| Output |
string |
Output perintah.
|
OutPutTestmsg |
| Repeats |
integer |
Jumlah kali perintah dieksekusi pada instans.
|
0 |
| StartTime |
string |
Waktu saat perintah mulai berjalan pada instans. Waktu ditampilkan dalam format ISO 8601 dalam UTC. |
2019-12-20T06:15:55Z |
| StopTime |
string |
Waktu saat StopInvocation dipanggil untuk menghentikan eksekusi perintah. Waktu ditampilkan dalam format ISO 8601 dalam UTC. |
2020-01-19T09:15:47Z |
| Timed |
boolean |
Apakah perintah yang dikueri dijadwalkan untuk berjalan secara otomatis di masa mendatang. |
false |
| UpdateTime |
string |
Waktu saat status perintah terakhir diperbarui. Waktu ditampilkan dalam format ISO 8601 dalam UTC. |
2020-01-19T09:15:47Z |
| InvokeStatus |
string |
Status eksekusi keseluruhan perintah. Catatan
Kami menyarankan Anda memeriksa parameter respons InvocationStatus sebagai ganti parameter ini. |
Finished |
| Launcher |
string |
Peluncur yang digunakan untuk menjalankan skrip. Panjang peluncur dapat mencapai 1 KB. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| OssOutputDelivery |
string |
Konfigurasi pengiriman OSS untuk output eksekusi perintah. |
oss://testBucket/testPrefix |
| Parameters |
string |
Parameter kustom dalam perintah. |
{} |
| RepeatMode |
string |
Mode eksekusi perintah. Nilai valid:
|
Once |
| Tags |
object |
||
| Tag |
array<object> |
Informasi tag dari eksekusi perintah. |
|
|
object |
Informasi tag dari eksekusi perintah. |
||
| TagKey |
string |
Kunci tag dari eksekusi perintah. |
owner |
| TagValue |
string |
Nilai tag dari eksekusi perintah. |
zhangsan |
| TerminationMode |
string |
Mode yang digunakan saat Tugas dihentikan (dihentikan secara manual atau terganggu karena melebihi batas waktu). Nilai valid:
|
ProcessTree |
| Timed |
boolean |
Apakah perintah yang dikueri dijadwalkan untuk berjalan secara otomatis di masa mendatang. |
false |
| Timeout |
integer |
Periode batas waktu maksimum untuk perintah berjalan pada instans ECS. Unit: seconds. Jika perintah tidak dapat berjalan karena alasan tertentu, batas waktu akan tercapai. Saat batas waktu tercapai, proses perintah dihentikan secara paksa dengan membatalkan PID perintah. |
60 |
| Username |
string |
Nama pengguna yang digunakan untuk menjalankan perintah pada instans ECS. |
test |
| WorkingDir |
string |
Direktori kerja perintah. |
/home/ |
| NextToken |
string |
Token halaman yang dikembalikan dalam panggilan ini. |
AAAAAdDWBF2 |
| PageNumber |
integer |
Nomor halaman dari hasil kueri. |
1 |
| PageSize |
integer |
Jumlah entri per halaman. |
10 |
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| TotalCount |
integer |
Jumlah total perintah. |
1 |
Contoh
Respons sukses
JSONformat
{
"Invocations": {
"Invocation": [
{
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"CommandDescription": "deskripsiSkrip",
"CommandId": "c-hz0jdfwcsr****",
"CommandName": "CommandTestName",
"CommandType": "RunShellScript",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-Kontainer",
"CreationTime": "2020-01-19T09:15:46Z",
"Frequency": "0 */20 * * * *",
"InvocationStatus": "Running",
"InvokeId": "t-hz0jdfwd9f****",
"InvokeInstances": {
"InvokeInstance": [
{
"CreationTime": "2019-12-20T06:15:54Z",
"Dropped": 0,
"ErrorCode": "InstanceNotExists",
"ErrorInfo": "Instans yang ditentukan tidak ada",
"ExitCode": 0,
"FinishTime": "2019-12-20T06:15:56Z",
"InstanceId": "i-bp1i7gg30r52z2em****",
"InstanceInvokeStatus": "Finished",
"InvocationStatus": "Success",
"OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
"OssOutputErrorInfo": "The invocation status does not support output delivery",
"OssOutputStatus": "Finished",
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"Output": "OutPutTestmsg",
"Repeats": 0,
"StartTime": "2019-12-20T06:15:55Z",
"StopTime": "2020-01-19T09:15:47Z",
"Timed": false,
"UpdateTime": "2020-01-19T09:15:47Z"
}
]
},
"InvokeStatus": "Finished",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"OssOutputDelivery": "oss://testBucket/testPrefix",
"Parameters": "{}",
"RepeatMode": "Once",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
},
"TerminationMode": "ProcessTree",
"Timed": false,
"Timeout": 60,
"Username": "test",
"WorkingDir": "/home/"
}
]
},
"NextToken": "AAAAAdDWBF2",
"PageNumber": 1,
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"TotalCount": 1
}
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 menentukan hingga 20 tag untuk operasi ini. |
| 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 | InvalidParameterCharacter | The specified parameter %s contains illegal characters. | |
| 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.