DescribeMonitoringAgentHosts - Cloud Monitor

Anda dapat memanggil operasi DescribeMonitoringAgentHosts untuk mengkueri daftar semua host, baik yang telah maupun belum memiliki Agen CloudMonitor terinstal.

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

cms:DescribeMonitoringAgentHosts

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
KeyWord	string	No	Kata kunci untuk pencarian fuzzy.	host1
HostName	string	No	Hostname.	hostNam1
InstanceIds	string	No	ID instans.	i-a3d1q1pm2f9yr29e****
SerialNumbers	string	No	Nomor seri host. Nomor seri global yang unik dihasilkan setelah Agen CloudMonitor berhasil diinstal pada sebuah host. Host yang bukan merupakan instans Alibaba Cloud tidak memiliki ID instans, tetapi memiliki nomor seri. Catatan Gunakan parameter ini untuk menemukan host yang dipantau secara spesifik.	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri yang ditampilkan per halaman. Nilai yang valid: 10 20 50 100 Catatan Alibaba Cloud tidak membatasi nilai maksimum parameter ini. Namun, mengatur parameter ini ke nilai yang besar dapat menyebabkan timeout.	10
InstanceRegionId	string	No	Wilayah tempat instans berada.	cn-hangzhou
AliyunHost	boolean	No	Menentukan apakah akan memfilter instans Elastic Compute Service (ECS) Alibaba Cloud. Nilai yang valid: true (default): Hanya mengembalikan instans ECS. false: Hanya mengembalikan host yang bukan instans ECS.	true
Status	string	No	Status host. Nilai yang valid: Running: Host sedang berjalan. Stopped: Host dihentikan, agen belum diinstal, atau instalasi agen gagal.	Running
SysomStatus	string	No	Status SysOM. Nilai yang valid: installing: SysOM sedang diaktifkan. running: SysOM sedang berjalan. stopped: SysOM dihentikan. uninstalling: SysOM sedang dinonaktifkan.	running

Elemen respons

Element	Type	Description	Example
	object	Respons.
RequestId	string	ID permintaan.	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	Menunjukkan apakah operasi berhasil. Nilai yang valid: true: Operasi berhasil. false: Operasi gagal.	true
Code	string	Kode status. Catatan Kode status 200 menunjukkan respons yang berhasil.	200
Message	string	Pesan error.	The Request is not authorization.
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
PageTotal	integer	Jumlah halaman.	50
Total	integer	Total jumlah entri.	10
Hosts	object
Host	array<object>	Daftar host.
	object	Host.
SerialNumber	string	Nomor seri host. Host yang bukan merupakan instans Alibaba Cloud tidak memiliki ID instans, tetapi memiliki nomor seri. Catatan Gunakan parameter ini untuk menemukan host yang dipantau secara spesifik.	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	Alamat IP NAT.	192.168.XX.XX
HostName	string	Hostname.	hostIP
AliUid	integer	ID Akun Alibaba Cloud.	103201326074****
NetworkType	string	Jenis jaringan.	vpc
InstanceId	string	ID instans.	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	Menunjukkan apakah host tersebut merupakan instans Alibaba Cloud. Nilai yang valid: true: Host merupakan instans Alibaba Cloud. false: Host bukan instans Alibaba Cloud.	true
EipAddress	string	Alamat IP elastis (EIP).	192.168.XX.XX
AgentVersion	string	Versi agen.	3.4.6
IpGroup	string	Alamat IP host. Catatan Beberapa alamat IP dipisahkan dengan koma (,).	192.168.XX.XX
EipId	string	ID EIP.	eip-bp16i16k9gcezyfrp****
Region	string	Wilayah.	cn-hangzhou
InstanceTypeFamily	string	Family tipe instans ECS.	ecs.n4
OperatingSystem	string	Sistem operasi.	Linux

Contoh

Respons sukses

JSONformat

{
  "RequestId": "63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": 1,
  "PageSize": 10,
  "PageTotal": 50,
  "Total": 10,
  "Hosts": {
    "Host": [
      {
        "SerialNumber": "x12335-6cc8-4a22-9f21-1a00a719****",
        "NatIp": "192.168.XX.XX",
        "HostName": "hostIP",
        "AliUid": 0,
        "NetworkType": "vpc",
        "InstanceId": "i-a2d5q7pm3f9yr212****",
        "isAliyunHost": true,
        "EipAddress": "192.168.XX.XX",
        "AgentVersion": "3.4.6",
        "IpGroup": "192.168.XX.XX",
        "EipId": "eip-bp16i16k9gcezyfrp****",
        "Region": "cn-hangzhou",
        "InstanceTypeFamily": "ecs.n4",
        "OperatingSystem": "Linux"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.