Updated on 2025-08-07 GMT+08:00

Querying the ICAgent Installed on a Host

Function

This API is used to query the ICAgent installed on a cluster host or a custom host.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/{cluster_id}/{namespace}/agents

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

  • Enter a cluster ID when a cluster host is queried.

  • Enter APM when a custom host is queried.

namespace

Yes

String

  • Enter a namespace when a cluster host is queried.

  • Enter APM when a custom host is queried.

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

No

String

Content type, which is application/json.

Response Parameters

Status code: 200

OK: The request is successful.

None

Example Requests

Query the ICAgent installed on a host.

https://{Endpoint}/v1/{project_id}/{cluster_id}/{namespace}/agents

Example Responses

Status code: 200

OK: The request is successful.

[ {
  "ip" : "10.**.**.13",
  "agentId" : "7b****93-7**1-4**e-8**b-3d****35**84",
  "devCloudId" : "",
  "nodeName" : "aom-docker-75079-iul66",
  "status" : "running",
  "lastModified" : "1700577655170",
  "updateTime" : "1701141177267",
  "version" : "5.13.110.52",
  "osType" : "linux",
  "pinpointVersion" : "1.0.29",
  "pinpointStatus" : "",
  "phpProbeVersion" : "",
  "dotnetProbeVersion" : "",
  "extendInfo" : null,
  "customHostTag" : null,
  "enterprise_project_id" : "d64fbcc8-c296-4a6f-8988-6850dfb08b47",
  "reserved" : "{\"cpu_used\":\"1.5\",\"goroutine_used\":9507,\"mem_used\":\"181556\",\"net_used\":0.1923828125}"
} ]

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.