Mengkueri informasi status satu atau beberapa instans ECS tertentu. API ini juga mendukung pengkuerian daftar instans berdasarkan kondisi tertentu.
Deskripsi operasi
Untuk status siklus hidup instans ECS, lihat Tabel status instans.
Contoh permintaan
Kueri instans dan informasi statusnya berdasarkan wilayah tertentu. Contoh parameter permintaan:
"RegionID": "cn-hangzhou"
Kueri instans dan informasi statusnya berdasarkan zona di bawah wilayah tertentu. Contoh parameter permintaan:
"RegionID": "cn-hangzhou",
"ZoneID": "cn-hangzhou-a"
Kueri informasi status instans berdasarkan wilayah tertentu dan ID instans. Contoh parameter permintaan:
"RegionID": "cn-hangzhou",
"InstancesID": ["i-bp1f7c1zqp999zvp****", "i-bp1dqjv36biueg61****"]
```.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeInstanceStatus |
list |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah instans. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah Alibaba Cloud terbaru. |
cn-hangzhou |
| ZoneId |
string |
No |
Zona tempat instans berada. Anda dapat memanggil DescribeZones untuk mengkueri daftar zona Alibaba Cloud terbaru. |
cn-hangzhou-d |
| ClusterId |
string |
No |
ID kluster tempat instans berada. Penting Parameter ini tidak digunakan lagi dan tidak direkomendasikan untuk digunakan. |
cls-bp67acfmxazb4p**** |
| PageNumber |
integer |
No |
Nomor halaman daftar status instans. Nilai awal: 1. Nilai default: 1. |
1 |
| PageSize |
integer |
No |
Jumlah entri per halaman yang ditetapkan saat melakukan kueri berhalaman. Nilai valid: 1 hingga 50. Nilai default: 10. |
10 |
| InstanceId |
array |
No |
Array ID instans. Panjang array: 1 hingga 100. Nilai contoh: ["i-bp1j4i2jdf3owlhe****", "i-bp1j4i2jdf3o1234****"]. |
i-bp1j4i2jdf3owlhe**** |
|
string |
No |
ID instans. |
i-bp1j4i2jdf3owlhe**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| PageSize |
integer |
Jumlah entri per halaman yang ditetapkan di input. |
1 |
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
Nomor halaman daftar instans. |
1 |
| TotalCount |
integer |
Jumlah total instans. |
58 |
| InstanceStatuses |
object |
||
| InstanceStatus |
array<object> |
Kumpulan ID dan status instans (InstanceStatus). |
|
|
object |
|||
| Status |
string |
The status of the instance. Valid values:
|
Running |
| InstanceId |
string |
The ID of the instance. |
i-bp1j4i2jdf3owlhe**** |
Contoh
Respons sukses
JSONformat
{
"PageSize": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 58,
"InstanceStatuses": {
"InstanceStatus": [
{
"Status": "Running",
"InstanceId": "i-bp1j4i2jdf3owlhe****"
}
]
}
}
Respons error
JSONformat
{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 10,
"InstanceStatuses": {
"InstanceStatus": [{
"InstanceId": "i-instance1",
"Status": "Running"
},
{
"InstanceId": "i-ae4r89pp",
"Status": "Stopped"
}]
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | |
| 403 | Abs.InvalidInstanceIds.MalFormed | The specified instanceIds is not valid. | |
| 404 | InvalidZoneId.NotFound | The ZoneId provided does not exist in our records. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.