Mengkueri hasil eksekusi satu atau beberapa perintah Asisten Cloud, khususnya hasil eksekusi aktual pada Instans ECS.
Deskripsi operasi
Deskripsi operasi
-
Setelah Anda mengeksekusi perintah, keberhasilan perintah atau hasil yang diharapkan tidak dijamin. Panggil operasi ini untuk melihat hasil eksekusi aktual berdasarkan output sebenarnya.
-
Anda dapat mengkueri informasi eksekusi dari 30 hari terakhir. Maksimal 10.000 catatan informasi 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 token untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, tetapkanNextTokenke nilai yang 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 agregasi di seluruh beberapa instans.DescribeInvocationResultshanya mengembalikan status eksekusi individu pada setiap instans, tanpa status agregasi di seluruh beberapa instans.
- Ketika satu panggilan
RunCommand/InvokeCommandmenentukan satu instans:DescribeInvocationsdanDescribeInvocationResultssebagian besar dapat saling menggantikan. Anda dapat mengganti salah satunya dengan yang lain.
Ketika Anda perlu melihat detail eksekusi Tugas terjadwal (periodik) atau Tugas yang dieksekusi pada setiap startup sistem (
RepeatMode=Period, EveryReboot), hanyaDescribeInvocationResultsyang dapat mengembalikan catatan historis eksekusi masa lalu (Anda harus menentukanIncludeHistory=true).DescribeInvocationshanya mengembalikan status Tugas terbaru.Ketika Anda perlu melihat konten atau parameter perintah, hanya
DescribeInvocationsyang mengembalikanCommandContent.
- Ketika satu panggilan
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeInvocationResults |
get |
Command.
Instans.
|
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 menjalankan perintah. Parameter ini memfilter hasil eksekusi perintah yang sesuai. |
rg-bp67acfmxazb4p**** |
| InvokeId |
string |
No |
ID eksekusi perintah. Anda dapat memanggil DescribeInvocations untuk mengkueri InvokeId. |
t-hz0jdfwd9f**** |
| InstanceId |
string |
No |
ID instans. |
i-bp1i7gg30r52z2em**** |
| CommandId |
string |
No |
ID perintah. |
c-hz0jdfwcsr**** |
| InvokeRecordStatus |
string |
No |
Status eksekusi perintah. Nilai valid:
|
Running |
| IncludeHistory |
boolean |
No |
Apakah akan mengembalikan catatan historis eksekusi perintah terjadwal. Nilai valid:
Nilai default: false. |
false |
| ContentEncoding |
string |
No |
Metode pengkodean untuk bidang
Nilai default: Base64. |
PlainText |
| PageNumber |
integer |
No |
Catatan
Parameter ini akan segera didepresiasi. Gunakan NextToken dan MaxResults untuk melakukan operasi kueri berhalaman. |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini akan segera didepresiasi. Gunakan NextToken dan MaxResults untuk melakukan operasi kueri berhalaman. |
1 |
| 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 |
| 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 Sumber daya dengan tag tersebut tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter Sumber daya, jumlah Sumber daya dengan semua tag yang ditentukan tidak boleh melebihi 1.000. Jika jumlah Sumber daya melebihi 1.000, panggil ListTagResources untuk menjalankan kueri. Panjang kunci tag maksimal 64 karakter dan tidak boleh dimulai dengan |
TestKey |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE***** |
| Invocation |
object |
Koleksi hasil eksekusi perintah. |
|
| PageSize |
integer |
Jumlah entri per halaman dalam kueri berhalaman. |
1 |
| PageNumber |
integer |
Nomor halaman saat ini. |
1 |
| TotalCount |
integer |
Jumlah total perintah. |
1 |
| NextToken |
string |
Token paginasi yang dikembalikan dalam panggilan ini. |
AAAAAdDWBF2 |
| InvocationResults |
object |
||
| InvocationResult |
array<object> |
Set hasil eksekusi perintah. |
|
|
array<object> |
|||
| Dropped |
integer |
Panjang teks yang dipotong dan dibuang setelah panjang teks dalam bidang |
0 |
| OssOutputDelivery |
string |
Konfigurasi pengiriman OSS untuk output eksekusi perintah. |
oss://testBucket/testPrefix |
| InvocationStatus |
string |
Status eksekusi perintah pada satu instans. Nilai valid:
|
Success |
| InstanceId |
string |
ID instans. |
i-bp1i7gg30r52z2em**** |
| ExitCode |
integer |
Kode keluar perintah.
|
0 |
| ErrorInfo |
string |
Detail kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai valid:
|
the specified instance does not exists |
| StartTime |
string |
Waktu ketika perintah mulai dieksekusi pada instans. |
2019-12-20T06:15:55Z |
| Repeats |
integer |
Jumlah kali perintah dieksekusi pada instans.
|
0 |
| InvokeRecordStatus |
string |
Status eksekusi perintah. Nilai valid:
|
Running |
| FinishedTime |
string |
Waktu ketika eksekusi perintah selesai. Jika eksekusi perintah mengalami timeout, waktu penyelesaian dihitung sebagai |
2019-12-20T06:15:56Z |
| 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 ketika pengiriman gagal. Bidang ini hanya dikembalikan ketika OssOutputStatus adalah Failed. Nilai 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 |
| Username |
string |
Nama pengguna yang digunakan untuk mengeksekusi perintah pada Instans ECS. |
test |
| ContainerId |
string |
ID kontainer. |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
Nama kontainer. |
test-container |
| Output |
string |
Output eksekusi perintah.
|
MTU6MzA6MDEK |
| Launcher |
string |
Launcher yang digunakan untuk mengeksekusi skrip. Panjangnya tidak boleh melebihi 1 KB. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| CommandId |
string |
ID perintah. |
c-hz0jdfwcsr**** |
| ErrorCode |
string |
Kode kesalahan untuk kegagalan pengiriman perintah atau kegagalan eksekusi. Nilai valid:
|
InstanceNotExists |
| InvokeId |
string |
ID eksekusi perintah. |
t-hz0jdfwd9f**** |
| TerminationMode |
string |
Mode yang digunakan saat menghentikan Tugas (penghentian manual atau interupsi karena timeout eksekusi). Nilai 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 |
| StopTime |
string |
Waktu ketika |
2020-01-19T09:15:47Z |
Contoh
Respons sukses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
"Invocation": {
"PageSize": 1,
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2",
"InvocationResults": {
"InvocationResult": [
{
"Dropped": 0,
"OssOutputDelivery": "oss://testBucket/testPrefix",
"InvocationStatus": "Success",
"InstanceId": "i-bp1i7gg30r52z2em****",
"ExitCode": 0,
"ErrorInfo": "the specified instance does not exists",
"StartTime": "2019-12-20T06:15:55Z",
"Repeats": 0,
"InvokeRecordStatus": "Running",
"FinishedTime": "2019-12-20T06:15:56Z",
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"OssOutputStatus": "Finished",
"OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
"OssOutputErrorInfo": "The invocation status does not support output delivery.",
"Username": "test",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"Output": "MTU6MzA6MDEK",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"CommandId": "c-hz0jdfwcsr****",
"ErrorCode": "InstanceNotExists",
"InvokeId": "t-hz0jdfwd9f****",
"TerminationMode": "ProcessTree",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
},
"StopTime": "2020-01-19T09:15:47Z"
}
]
}
}
}
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. |
| 500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 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.