All Products
Search
Document Center

Cloud Monitor:DescribeMonitoringAgentStatuses

Last Updated:Jun 11, 2026

Mengkueri status berjalan Agen CloudMonitor dengan memanggil operasi DescribeMonitoringAgentStatuses.

Deskripsi operasi

This topic describes how to query the status of the CloudMonitor agent that is installed on the i-hp3dunahluwajv6f**** instance. The result indicates that the CloudMonitor agent is in the running state.

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:DescribeMonitoringAgentStatuses

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

InstanceIds

string

No

ID instans. Pisahkan beberapa ID instans dengan koma (,).

i-hp3dunahluwajv6f****

HostAvailabilityTaskId

string

No

ID tugas pemantauan ketersediaan.

126****

Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element

Type

Description

Example

object

The response parameters.

Code

string

The HTTP status code.

Catatan

The status code 200 indicates that the request was successful.

200

Message

string

The error message.

The specified resource is not found.

RequestId

string

The request ID.

6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F

Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

true

NodeStatusList

object

NodeStatus

array<object>

The host status information.

object

Status

string

The status of the CloudMonitor agent. Valid values:

  • running: The CloudMonitor agent is running.

  • stopped: The CloudMonitor agent is stopped.

  • installing: The CloudMonitor agent is being installed.

  • install_faild: The CloudMonitor agent fails to be installed.

  • abnormal: The CloudMonitor agent is not properly installed.

  • not_installed: The CloudMonitor agent is not installed.

running

InstanceId

string

The instance ID.

i-hp3dunahluwajv6f****

AutoInstall

boolean

Indicates whether the CloudMonitor agent is automatically installed. Valid values:

  • true: The CloudMonitor agent is automatically installed.

  • false: The CloudMonitor agent is not automatically installed.

true

OsMonitorStatus

string

The status of SysOM. Valid values:

  • installing: SysOM is being installed.

  • running: SysOM is running.

  • stopped: SysOM is stopped.

  • uninstalling: SysOM is being uninstalled.

running

OsMonitorErrorCode

string

The error status of SysOM. Valid values:

  • install_fail: SysOM fails to be installed or an unknown error occurs.

  • install_assist_invalid: SysOM fails to be installed because the status of Cloud Assistant is invalid.

  • install_assist_command_fail: SysOM fails to be installed because the installation command fails to run.

  • uninstall_fail: SysOM fails to be uninstalled or an unknown error occurs.

  • uninstall_assist_invalid: SysOM fails to be uninstalled because the status of Cloud Assistant is invalid.

  • uninstall_assist_command_fail: SysOM fails to be uninstalled because the uninstallation command fails to run.

install_fail

OsMonitorErrorDetail

string

The details of the execution error. Valid values:

  • Command.ErrorCode.Fail.Downlaod.REGIN_ID: Failed to obtain the region ID.

  • Command.ErrorCode.Fail.Downlaod.SYSAK: Failed to download the .rpm package of System Analyse Kit (SysAK).

  • Command.ErrorCode.Fail.Downlaod.CMON_FILE: Failed to download the CMON file.

  • Command.ErrorCode.Fail.Downlaod.BTF: Failed to start SysAK because the BTF file is not found.

  • Command.ErrorCode.Fail.Start.SYSAK: Failed to start SysAK due to an unknown error.

Command.ErrorCode.Fail.Downlaod.REGIN_ID

OsMonitorVersion

string

The SysOM version.

1.3.0-12

OsMonitorConfig

string

Indicates whether the SysAK monitoring feature is enabled.`` Valid values:

  • true: The SysAK monitoring feature is enabled.

  • false: the SysAK monitoring feature is disabled.

{"sysak":true}

AgentInstallErrorCode

string

The error code returned when the CloudMonitor agent is installed. Valid values:

  • Common.Timeout: The installation timed out.

  • Common.SLR: The service-linked role for CloudMonitor is unauthorized.

  • Common.OS: The operating system is not supported.

  • Assist.Invalid: Cloud Assistant is not running.

  • Assist.Invoke: An error occurred when the installation program is started.

  • Assist.Execute: An error occurred when the installation program is running.

Assist.Invalid

LoongCollectorVersion

string

LoongCollector Version

0.1.0

LoongCollectorStatus

string

LoongCollector Status

Valid values:

  • running :

    Normal

  • stopped :

    Stopped

running

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F",
  "Success": true,
  "NodeStatusList": {
    "NodeStatus": [
      {
        "Status": "running",
        "InstanceId": "i-hp3dunahluwajv6f****",
        "AutoInstall": true,
        "OsMonitorStatus": "running",
        "OsMonitorErrorCode": "install_fail",
        "OsMonitorErrorDetail": "Command.ErrorCode.Fail.Downlaod.REGIN_ID",
        "OsMonitorVersion": "1.3.0-12",
        "OsMonitorConfig": "{\"sysak\":true}",
        "AgentInstallErrorCode": "Assist.Invalid",
        "LoongCollectorVersion": "0.1.0",
        "LoongCollectorStatus": "running"
      }
    ]
  }
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 ParameterInvalid Illegal parameters.
500 InternalError %s
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.