Gunakan DescribeMonitoringAgentHosts untuk kueri daftar semua host - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Mengkueri daftar semua host, terlepas dari apakah 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 unik global dihasilkan setelah Agen CloudMonitor berhasil diinstal pada host. Host yang bukan instans Alibaba Cloud tidak memiliki ID instans, tetapi memiliki nomor seri. Catatan Gunakan parameter ini untuk mencari host yang dipantau tertentu.	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai valid: 10 20 50 100 Catatan Alibaba Cloud tidak membatasi nilai maksimum parameter ini. Namun, menyetel parameter ini ke nilai Tingkat Tinggi dapat menyebabkan timeout.	10
InstanceRegionId	string	No	Wilayah tempat instans berada.	cn-hangzhou
AliyunHost	boolean	No	Apakah akan memfilter instans Alibaba Cloud Elastic Compute Service (ECS). Nilai valid: true (default): Hanya mengembalikan Instance ECS. false: Hanya mengembalikan host yang bukan Instance ECS.	true
Status	string	No	Status host. Nilai valid: Running: Host sedang berjalan. Stopped: Host dihentikan, agen tidak terinstal, atau penginstalan agen gagal.	Running
SysomStatus	string	No	Status SysOM. Nilai valid: installing: SysOM sedang diaktifkan. running: SysOM sedang berjalan. stopped: SysOM dihentikan. uninstalling: SysOM sedang dinonaktifkan.	running

Elemen respons

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Code	string	The status code. Catatan A status code of 200 indicates a successful response.	200
Message	string	The error message.	The Request is not authorization.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
PageTotal	integer	The number of pages.	50
Total	integer	The total number of entries.	10
Hosts	object
Host	array<object>	The list of hosts.
	object	The host.
SerialNumber	string	The serial number of the host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number. Catatan Use this parameter to find a specific monitored host.	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	The NAT IP address.	192.168.XX.XX
HostName	string	The hostname.	hostIP
AliUid	integer	The ID of the Alibaba Cloud account.	103201326074****
NetworkType	string	The network type.	vpc
InstanceId	string	The instance ID.	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	Indicates whether the host is an Alibaba Cloud instance. Valid values: true: The host is an Alibaba Cloud instance. false: The host is not an Alibaba Cloud instance.	true
EipAddress	string	The elastic IP address (EIP).	192.168.XX.XX
AgentVersion	string	The agent version.	3.4.6
IpGroup	string	The IP address of the host. Catatan Multiple IP addresses are separated by commas (,).	192.168.XX.XX
EipId	string	The ID of the EIP.	eip-bp16i16k9gcezyfrp****
Region	string	The region.	cn-hangzhou
InstanceTypeFamily	string	The ECS instance type family.	ecs.n4
OperatingSystem	string	The operating system.	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.