DescribeManagedInstances - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri daftar instans terkelola.

Deskripsi operasi

Saat melakukan kueri berhalaman untuk halaman pertama, Anda hanya perlu menyesuaikan pengaturan MaxResults untuk membatasi jumlah entri yang dikembalikan. NextToken dalam tanggapan akan digunakan sebagai token untuk melakukan paging halaman berikutnya. Saat melakukan kueri berhalaman untuk halaman berikutnya, atur parameter NextToken ke nilai NextToken yang diperoleh dari tanggapan sebelumnya, lalu sesuaikan pengaturan MaxResults untuk membatasi jumlah entri yang dikembalikan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeManagedInstances

get

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Wilayah yang 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 linux FreeBSD	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 mendaftarkan instans terkelola. Nilai dapat memiliki panjang hingga 36 karakter. Contoh skrip pendaftaran: `aliyun-service --register \ --RegionId=cn-hangznou \ --ActivationId=xxxxxxxxxxx \ --ActivationCode=xxxxxxxxx \ --MachineId=xxxxxx \ # Parameter opsional, yang menentukan pengenal unik mesin --ForceResue` Jika parameter MachineId dan ForceResult ditentukan saat pendaftaran, Asisten Cloud menghasilkan ID instans terkelola tetap untuk MachineId ini. Jika parameter MachineId tidak ditentukan secara eksplisit, Asisten Cloud secara otomatis menghasilkan nilai MachineId berdasarkan informasi perangkat keras mesin. Rekomendasi: Tentukan parameter MachineId dan ForceResult secara eksplisit untuk menandai pemetaan antara instans terkelola dan mesin on-premises.	GOG4X8312A0188
InstanceName	string	No	Nama instans terkelola.	my-webapp-server
PageNumber	integer	No	Catatan Parameter ini akan segera dihentikan. Kami menyarankan Anda menggunakan NextToken dan MaxResults untuk operasi paging dan kueri berhalaman.	1
PageSize	integer	No	Catatan Parameter ini akan segera dihentikan. Kami menyarankan Anda menggunakan NextToken dan MaxResults untuk operasi paging dan kueri berhalaman.	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	Daftar tag.
	object	No	Daftar tag.
Key	string	No	Kunci tag instans terkelola. Nilai valid N: 1 hingga 20. Nilai tidak boleh berupa string kosong. Jika Anda menggunakan satu tag untuk memfilter sumber daya, jumlah sumber daya di bawah tag ini tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang disambungkan dengan beberapa tag tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, Anda harus menggunakan operasi ListTagResources untuk mengkueri sumber daya. Kunci tag dapat memiliki panjang hingga 64 karakter. Kunci tidak boleh diawali dengan aliyun atau acs:, dan tidak boleh mengandung http:// atau https://.	TestKey
Value	string	No	Nilai tag instans terkelola. Nilai valid N: 1 hingga 20. Nilai dapat berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung http:// atau https://.	TestValue
MaxResults	integer	No	Jumlah maksimum entri yang dikembalikan pada setiap halaman selama paging atau kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
NextToken	string	No	Token pagination. Atur nilai ke nilai NextToken yang dikembalikan dari pemanggilan API sebelumnya.	AAAAAdDWBF2****
ResourceGroupId	string	No	ID kelompok sumber daya tempat instans terkelola berada.	rg-123******
Connected	string	No	Apakah instans terkelola terhubung. Nilai valid: true: Instans terkelola terhubung. Anda dapat mengelola instans terkelola menggunakan Asisten Cloud. false: Instans terkelola tidak terhubung. Server mungkin dihentikan atau Agen Asisten Cloud 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. Nilai valid: true: Instans terkelola terhubung. Anda dapat mengelola instans terkelola menggunakan Asisten Cloud. false: Instans terkelola tidak terhubung. Server mungkin dihentikan atau Agen Asisten Cloud tidak terinstal dengan benar.	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 Tugas Asisten Cloud yang dieksekusi pada instans terkelola.	1
LastInvokedTime	string	Waktu saat Tugas Asisten Cloud terakhir dieksekusi. Waktu ditampilkan dalam format ISO 8601 di zona waktu UTC.	2021-01-20T09:00:40Z
MachineId	string	ID 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 di zona waktu UTC.	2021-01-20T08:57:56Z
ResourceGroupId	string	ID kelompok sumber daya tempat instans terkelola berada.	rg-123******
Tags	array<object>	Daftar tag.
	object	Daftar tag.
TagKey	string	Kunci tag instans terkelola. Nilai valid N: 1 hingga 20. Nilai tidak boleh berupa string kosong. Jika Anda menggunakan satu tag untuk memfilter sumber daya, jumlah sumber daya di bawah tag ini tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang disambungkan dengan beberapa tag tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, Anda harus menggunakan operasi ListTagResources untuk mengkueri sumber daya. Kunci tag dapat memiliki panjang hingga 64 karakter. Kunci tidak boleh diawali dengan aliyun atau acs:, dan tidak boleh mengandung http:// atau https://.	TestKey
TagValue	string	Nilai tag instans terkelola. Nilai valid N: 1 hingga 20. Nilai dapat berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung http:// atau https://.	TestValue
NextToken	string	Token pagination yang dikembalikan untuk pemanggilan ini.	AAAAAdDWBF2
PageNumber	integer	Nomor halaman daftar instans terkelola.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
RequestId	string	ID permintaan.	77115469-F2C5-4ECA-94F7-FA04F2FD****
TotalCount	integer	Jumlah total instans terkelola yang dikueri. Catatan Saat Anda menggunakan parameter MaxResults dan NextToken untuk paging dan kueri berhalaman, nilai TotalCount yang dikembalikan tidak memiliki arti.	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 yang ditentukan. Periksa apakah nilai parameter RegionId sudah 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 pada 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 ini tersedia di wilayah yang ditentukan.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.