Mengkueri daftar instans terkelola.
Deskripsi operasi
Saat melakukan kueri halaman untuk halaman pertama, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken dalam tanggapan berfungsi sebagai token untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, tetapkan parameter NextToken ke nilai NextToken yang diperoleh dari tanggapan sebelumnya sebagai token kueri, dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeManagedInstances |
get |
Instance.
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah. Wilayah berikut didukung: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), Hong Kong (China), Singapore, Japan (Tokyo), US (Silicon Valley), dan US (Virginia). Anda dapat memanggil DescribeRegions untuk mengkueri ID wilayah dan informasi lainnya. |
cn-hangzhou |
| OsType |
string |
No |
Tipe sistem operasi instans terkelola. Nilai valid:
|
windows |
| InstanceIp |
string |
No |
Alamat IP internal atau alamat IP publik instans terkelola. |
192.168.**.** |
| ActivationId |
string |
No |
ID kode aktivasi. |
4ECEEE12-56F1-4FBC-9AB1-890F7494**** |
| MachineId |
string |
No |
Nilai parameter MachineId yang ditentukan saat instans terkelola didaftarkan. Nilai dapat memiliki panjang hingga 36 karakter. Contoh skrip pendaftaran:
|
GOG4X8312A0188 |
| InstanceName |
string |
No |
Nama instans terkelola. |
my-webapp-server |
| PageNumber |
integer |
No |
Catatan
Parameter ini akan segera didepresiasi. Gunakan NextToken dan MaxResults untuk menyelesaikan operasi kueri halaman. |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini akan segera didepresiasi. Gunakan NextToken dan MaxResults untuk menyelesaikan operasi kueri halaman. |
10 |
| InstanceId |
array |
No |
ID instans terkelola. Nilai valid N: 1 hingga 50. |
mi-hz018jrc1o0**** |
|
string |
No |
ID instans terkelola. Nilai valid N: 1 hingga 50. |
mi-hz018jrc1o0**** |
|
| Tag |
array<object> |
No |
Tag. |
|
|
object |
No |
Tag. |
||
| Key |
string |
No |
Kunci tag instans terkelola. 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 yang ditentukan tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang memiliki semua tag terlampir tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, panggil operasi ListTagResources untuk mengkueri sumber daya. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh diawali dengan |
TestKey |
| Value |
string |
No |
Nilai tag instans terkelola. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung |
TestValue |
| MaxResults |
integer |
No |
Jumlah maksimum entri per halaman dalam kueri halaman. 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**** |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya tempat instans terkelola berada. |
rg-123****** |
| Connected |
string |
No |
Apakah instans terkelola terhubung. true: Instans terkelola terhubung. Anda dapat mengelola instans terkelola menggunakan Asisten Cloud. false: Instans terkelola tidak terhubung. Server mungkin dimatikan atau Agen Asisten Cloud mungkin tidak terinstal dengan benar. |
true |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| Instances |
array<object> |
Daftar instans terkelola. |
|
|
array<object> |
|||
| ActivationId |
string |
ID kode aktivasi. |
3704F543-F768-43FA-9864-897F75B3**** |
| AgentVersion |
string |
Nomor versi Agen Asisten Cloud. |
2.2.0.102 |
| Connected |
boolean |
Apakah instans terkelola terhubung.
|
true |
| Hostname |
string |
Hostname instans terkelola. |
demo |
| InstanceId |
string |
ID instans terkelola. |
mi-hz018jrc1o0**** |
| InstanceName |
string |
Nama instans terkelola. |
webAPP-linux-01 |
| InternetIp |
string |
Alamat IP publik instans terkelola. |
40.65.**.** |
| IntranetIp |
string |
Alamat IP internal instans terkelola. |
10.0.**.** |
| InvocationCount |
integer |
Jumlah kali Tugas Asisten Cloud telah dieksekusi pada instans terkelola. |
1 |
| LastInvokedTime |
string |
Waktu saat Tugas Asisten Cloud terakhir dieksekusi. Waktu ditampilkan dalam format ISO 8601 UTC. |
2021-01-20T09:00:40Z |
| MachineId |
string |
Kode mesin instans terkelola. |
e03231b37ab14e53b5795ad625fc**** |
| OsType |
string |
Sistem operasi instans terkelola. |
Linux |
| OsVersion |
string |
Informasi versi sistem operasi. |
Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64 |
| RegistrationTime |
string |
Waktu pendaftaran instans terkelola. Waktu ditampilkan dalam format ISO 8601 UTC. |
2021-01-20T08:57:56Z |
| ResourceGroupId |
string |
ID kelompok sumber daya tempat instans terkelola berada. |
rg-123****** |
| Tags |
array<object> |
Tag. |
|
|
object |
Tag. |
||
| TagKey |
string |
Kunci tag instans terkelola. 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 yang ditentukan tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang memiliki semua tag terlampir tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, panggil operasi ListTagResources untuk mengkueri sumber daya. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh diawali dengan |
TestKey |
| TagValue |
string |
Nilai tag instans terkelola. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung |
TestValue |
| NextToken |
string |
Token paginasi yang dikembalikan dalam panggilan ini. |
AAAAAdDWBF2 |
| PageNumber |
integer |
Nomor halaman daftar instans terkelola. |
1 |
| PageSize |
integer |
Jumlah entri per halaman sesuai yang ditentukan dalam permintaan. |
10 |
| RequestId |
string |
ID permintaan. |
77115469-F2C5-4ECA-94F7-FA04F2FD**** |
| TotalCount |
integer |
Jumlah total instans terkelola yang dikueri. |
1 |
Contoh
Respons sukses
JSONformat
{
"Instances": [
{
"ActivationId": "3704F543-F768-43FA-9864-897F75B3****",
"AgentVersion": "2.2.0.102",
"Connected": true,
"Hostname": "demo",
"InstanceId": "mi-hz018jrc1o0****",
"InstanceName": "webAPP-linux-01",
"InternetIp": "40.65.**.**",
"IntranetIp": "10.0.**.**",
"InvocationCount": 1,
"LastInvokedTime": "2021-01-20T09:00:40Z",
"MachineId": "e03231b37ab14e53b5795ad625fc****",
"OsType": "Linux",
"OsVersion": "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
"RegistrationTime": "2021-01-20T08:57:56Z",
"ResourceGroupId": "rg-123******",
"Tags": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
}
],
"NextToken": "AAAAAdDWBF2",
"PageNumber": 1,
"PageSize": 10,
"RequestId": "77115469-F2C5-4ECA-94F7-FA04F2FD****",
"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 | InvalidParam.PageNumber | The specified parameter is invalid. | |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | |
| 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 | NumberExceed.Tags | The Tags parameter number is exceed. | Jumlah tag melebihi batas maksimum. Anda dapat menentukan hingga 20 tag untuk operasi ini. |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | Tentukan kunci tag. |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | Terdapat kunci duplikat dalam tag. Pastikan semua kunci unik. |
| 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. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.