Help Center/ Data Security Center/ API Reference/ API Description/ Device Management/ Obtaining the Device Status List
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Device Status List

Function

This API is used to obtain the monitoring status of all devices in a project.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/devices/monitor-info

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

monitor_infos

Array of MonitorInfo objects

Device status information list.

total

Integer

Total number of records.
Table 3 MonitorInfo

Parameter

Type

Description

description

String

Description.

id

String

ID

ip

String

Device IP address.

license_info

LicenseInfo object

License information.

name

String

Name.

os_info

OsInfo object

VM resource specifications.

status

String

Status.

type

Integer

Type.
Table 4 LicenseInfo

Parameter

Type

Description

license

String

License information.

license_end

Long

License expiration time.

license_start

Long

License effective time.
Table 5 OsInfo

Parameter

Type

Description

cpu

String

vCPUs.

disk

String

Disk size.

mem

String

Memory size.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Query result.

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified project does not exist.

Error Codes

See Error Codes.

Parent topic: Device Management