Obtaining Instance Monitoring Data

Function

This API is used to obtain instance monitoring data.

URI

POST /v1/{project_id}/audit/{instance_id}/system/monitorinfo

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Constraints N/A Range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Constraints N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. Default Value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. The token can be queried by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints: N/A Value range: You can obtain the value by calling the IAM API used to query a user token. Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
time	Yes	Duration object	Query time range. time_range takes precedence over start_time/end_time.

**Table 4** Duration
Parameter	Mandatory	Type	Description
end_time	No	String	End time
start_time	No	String	Start time
time_range	No	String	Time range. HALF_HOUR: half an hour HOUR: 1 hour THREE_HOUR: 3 hours TWELVE_HOUR: 12 hours DAY: 1 day WEEK: 1 week MONTH: one month

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
disk_infos	DiskInfo object	Disk Usage
system_infos	Array of SystemInfo objects	System information
traffic_infos	Array of TrafficInfo objects	Data Statistics

**Table 6** DiskInfo
Parameter	Type	Description
data_available	Double	Available Data Disk
data_total	Double	Total Data Disk Capacity
data_use_percent	Integer	Data Disk Usage Percentage
id	String	Recording the ID
swap_available	Double	Available Temporary Directory Space
swap_total	Double	Total capacity of the temporary directory
swap_use_percent	Integer	Usage percentage of the temporary directory
system_available	Double	Available System Disks
system_total	Double	System Disk
system_use_percent	Integer	System Disk Usage Percentage
time	String	Time

**Table 7** SystemInfo
Parameter	Type	Description
cpu_use	Double	CPU usage.
id	String	Record ID.
mem_use	Double	Memory usage.
time	String	Time when data is recorded.

**Table 8** TrafficInfo
Parameter	Type	Description
id	String	Record ID.
rxmegabytes	Double	Number of bytes received per second
time	String	Time
txmegabytes	Double	Number of bytes sent per second

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 10** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 401

**Table 11** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 12** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 14** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 16** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v1/{project_id}/audit/{instance_id}/system/monitorinfo

{
  "time" : {
    "time_range" : "HOUR",
    "end_time" : "",
    "start_time" : ""
  }
}

Example Responses

Status code: 200

{
  "system_infos" : [ {
    "id" : null,
    "time" : "2025-08-18 16:00:00-2025-08-18 16:37:17",
    "cpu_use" : 1,
    "mem_use" : 43.39
  }, {
    "id" : null,
    "time" : "2025-08-18 16:37:17-2025-08-18 17:14:34",
    "cpu_use" : 1,
    "mem_use" : 43.38
  } ],
  "traffic_infos" : [ {
    "id" : null,
    "time" : "2025-08-18 16:00:00-2025-08-18 16:37:17",
    "txmegabytes" : 0.0125,
    "rxmegabytes" : 0.0125
  } ],
  "disk_infos" : {
    "id" : null,
    "time" : "2025-08-19 14:50:00",
    "system_available" : 13.47,
    "system_total" : 18.59,
    "system_use_percent" : 28,
    "data_available" : 955.56,
    "data_total" : 1006.85,
    "data_use_percent" : 5,
    "swap_available" : 0,
    "swap_total" : 0,
    "swap_use_percent" : 0
  }
}