Mengkueri status plugin Asisten Cloud pada instans.
Deskripsi operasi
- Anda dapat mengkueri status plugin Asisten Cloud pada instans hanya jika versi Agen Asisten Cloud pada instans tidak lebih lama dari versi berikut:
Linux: 2.2.3.344.
Windows: 2.1.3.344.
Saat melakukan kueri berhalaman, untuk halaman pertama paging, Anda hanya perlu menentukan pengaturan
MaxResultsuntuk membatasi jumlah entri yang dikembalikan. NilaiNextTokendalam tanggapan berfungsi sebagai token untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, atur parameterNextTokenkeNextTokenyang diperoleh dari tanggapan sebelumnya sebagai token kueri, dan tentukan pengaturanMaxResultsuntuk membatasi jumlah entri yang dikembalikan.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru. |
cn-hangzhou |
| InstanceId |
array |
No |
ID instans. Anda dapat menentukan hingga 50 ID instans dalam satu permintaan. Nilai valid N: 1 hingga 50. |
|
|
string |
No |
ID instans. Anda dapat menentukan hingga 50 ID instans dalam satu permintaan. Nilai valid N: 1 hingga 50. |
i-bp1iudwa5b1tqa**** |
|
| Name |
string |
No |
Nama plugin. Nama mendukung semua set karakter dan dapat memiliki panjang hingga 255 karakter.
|
testPluginName |
| PageNumber |
integer |
No |
Catatan
Parameter ini akan segera dihentikan. Kami menyarankan Anda menggunakan NextToken dan MaxResults untuk melakukan kueri berhalaman dan operasi paging. |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini akan segera dihentikan. Kami menyarankan Anda menggunakan NextToken dan MaxResults untuk melakukan kueri berhalaman dan operasi paging. |
10 |
| MaxResults |
integer |
No |
Jumlah maksimum entri yang dikembalikan pada setiap halaman selama kueri berhalaman atau paging. Nilai maksimum: 50. Nilai default: 10. |
10 |
| NextToken |
string |
No |
Token paging. Atur nilai ke nilai NextToken yang dikembalikan dalam permintaan sebelumnya. |
AAAAAdDWBF2 |
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 dari hasil yang dikembalikan. |
1 |
| TotalCount |
integer |
Jumlah total entri yang memenuhi kondisi kueri. |
1 |
| NextToken |
string |
Token paging yang dikembalikan dalam tanggapan saat ini. |
AAAAAdDWBF2 |
| InstancePluginStatusSet |
object |
||
| InstancePluginStatus |
array<object> |
Daftar status plugin untuk instans. |
|
|
array<object> |
Daftar status plugin untuk instans. |
||
| InstanceId |
string |
ID instans |
i-xxxxx |
| PluginStatusSet |
object |
||
| PluginStatus |
array<object> |
Daftar status plugin. |
|
|
object |
Daftar status plugin. |
||
| PluginStatus |
string |
Status plugin. Nilai valid:
|
Running |
| PluginVersion |
string |
Versi plugin. |
1.1 |
| PluginName |
string |
Nama plugin. |
testName |
| FirstHeartbeatTime |
string |
Waktu saat Asisten Cloud pertama kali melaporkan status plugin. Waktu mengikuti standar ISO 8601 dan berada di zona waktu UTC. |
2020-01-19T09:15:46Z |
| LastHeartbeatTime |
string |
Waktu saat Asisten Cloud terakhir kali melaporkan status plugin. Waktu mengikuti standar ISO 8601 dan berada di zona waktu UTC. |
2020-01-19T09:15:46Z |
Contoh
Respons sukses
JSONformat
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2",
"InstancePluginStatusSet": {
"InstancePluginStatus": [
{
"InstanceId": "i-xxxxx",
"PluginStatusSet": {
"PluginStatus": [
{
"PluginStatus": "Running",
"PluginVersion": "1.1",
"PluginName": "testName",
"FirstHeartbeatTime": "2020-01-19T09:15:46Z",
"LastHeartbeatTime": "2020-01-19T09:15:46Z"
}
]
}
}
]
}
}
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 yang ditentukan. Periksa apakah nilai parameter RegionId sudah benar. |
| 400 | InvalidParam.PageNumber | The specified parameter PageNumber is invalid. | Parameter PageNumber yang ditentukan tidak valid. |
| 400 | InvalidParam.PageSize | The specified parameter PageSize is invalid. | Parameter PageSize yang ditentukan tidak valid. |
| 400 | PluginName.MissingValue | The plugin name must be specified when the number of InstanceIds is not 1. | Saat jumlah instans yang ditentukan bukan 1, nama plugin harus ditentukan. |
| 400 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | |
| 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 | InvalidInstance.NotFound | The specified instance does not exist. | Instans yang ditentukan tidak ada. |
| 404 | InvalidPluginName.NotFound | The specified plugin name does not exist. | Nama plugin yang ditentukan tidak ada. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.