Help Center/ Data Security Center/ API Reference/ API Description/ API Application Security Gateway Management/ Obtaining Node Metrics
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Node Metrics

Function

This API is used to obtain metrics of a node in a specified instance, including the CPU usage, memory usage, and disk usage.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/instances/{instance_id}/nodes/{node_id}/metrics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

node_id

Yes

String

Node ID.

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

from

No

String

Start time of the query metric.

period

No

Integer

Interval of the query metric.

to

No

String

End time of the query metric.

limit

No

Integer

Maximum number of returned result.

offset

No

Integer

Offset of the returned result.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of InstanceMetricVo objects

Instance metric information.
Table 4 InstanceMetricVo

Parameter

Type

Description

cpu_usage

String

CPU usage.

data_disk_free

String

Free data disk space.

data_disk_total

String

Total data disk space.

disk_free

String

Free disk space.

disk_total

String

Total disk space.

mem_usage

String

Memory usage.

timestamp

Long

Timestamp.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

401

Unauthorized.

403

Access denied.

404

Not found.

Error Codes

See Error Codes.