Help Center/Cloud Data Center/API Reference/API/Physical Server Management/Querying the Server Hardware Details

Updated on 2025-12-19 GMT+08:00

Querying the Server Hardware Details

Function

This API is used to obtain hardware details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/physicalservers/{id}/hardware-attributes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. Constraints N/A Range Project ID of the account. Default Value N/A
id	Yes	String	Definition Server ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
summary	HardwareSummary object	Definition Hardware overview information, including the server manufacturer, model, and serial number. Constraints N/A
memorys	Array of Memory objects	Definition The list of memory details. Constraints N/A
processors	Array of Processors objects	Definition The list of CPU details. Constraints N/A
network_adapters	Array of NetworkAdapter objects	Definition The list of network adapter details. Constraints N/A
fans	Array of Fan objects	Definition The list of fan details. Constraints N/A
powers	Array of Power objects	Definition The list of power supply details. Constraints N/A
storage_controllers	Array of StorageController objects	Definition The list of storage controller details. Constraints N/A
metrics	Array of HardwareMetric objects	Definition Monitoring metric information. Constraints N/A

**Table 4** HardwareSummary
Parameter	Type	Description
sn	String	Definition serial number Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Manufacturer. Constraints N/A Range N/A Default Value N/A
model	String	Definition Model. Constraints N/A Range N/A Default Value N/A
main_board_manufacturer	String	Definition Mainboard vendor. Constraints N/A Range N/A Default Value N/A
main_board_serial_number	String	The mainboard serial number.

**Table 5** Memory
Parameter	Type	Description
name	String	Definition Memory module name. Constraints N/A Range N/A Default Value N/A
capacity_mib	Integer	Definition Total memory capacity in MiB. Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Manufacturer. Constraints N/A Range N/A Default Value N/A
memory_device_type	String	Definition Memory type: DDR4 or DDR6. Constraints N/A Range N/A Default Value N/A
allowed_speed_mhz	Integer	Definition Clock frequency in MHz. Constraints N/A Range N/A Default Value N/A
operating_speed_mhz	Integer	Definition Current clock frequency in MHz. Constraints N/A Range N/A Default Value N/A
serial_number	String	Definition Serial number. Constraints N/A Range N/A Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A
state	String	Definition Hardware status. Constraints N/A Range Enabled Unenabled Unknown Default Value N/A
rank_count	Integer	Definition The number of memory ranks. Constraints N/A Range N/A Default Value N/A
data_width_bits	Integer	Definition Data bandwidth. Constraints N/A Range N/A Default Value N/A
part_number	String	Definition Component No. Constraints N/A Range N/A Default Value N/A
min_voltage_millivolt	Integer	Definition Minimum voltage. Constraints N/A Range N/A Default Value N/A
bom_number	String	Definition BOM code. Constraints N/A Range N/A Default Value N/A
type_detail	String	Definition Memory types. Constraints N/A Range N/A Default Value N/A
technology	String	Definition Physical memory technology type. Constraints N/A Range N/A Default Value N/A
position	String	Definition Location. Constraints N/A Range N/A Default Value N/A

**Table 6** Processors
Parameter	Type	Description
name	String	Definition Processor name. Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Manufacturer. Constraints N/A Range N/A Default Value N/A
model	String	Definition Processor model. Constraints N/A Range N/A Default Value N/A
total_cores	Integer	Definition The total number of processor cores. Constraints N/A Range N/A Default Value N/A
total_enabled_cores	Integer	Definition The number of enabled processor cores. Constraints N/A Range N/A Default Value N/A
total_threads	Integer	Definition The total number of processor threads. Constraints N/A Range N/A Default Value N/A
total_enabled_threads	Integer	Definition The total number of enabled threads. Constraints N/A Range N/A Default Value N/A
socket	Integer	Definition Processor slot number. Constraints N/A Range N/A Default Value N/A
max_speed_mhz	Integer	Definition Maximum CPU clock speed (unit: MHz). Constraints N/A Range N/A Default Value N/A
temperature	Integer	Definition Processor temperature. Constraints N/A Range N/A Default Value N/A
l1_cache_kib	Integer	Definition L1 cache (unit: KiB). Constraints N/A Range N/A Default Value N/A
l2_cache_kib	Integer	Definition L2 cache (unit: KiB). Constraints N/A Range N/A Default Value N/A
l3_cache_kib	Integer	Definition L3 cache (unit: KiB). Constraints N/A Range N/A Default Value N/A
frequency_mhz	Integer	Definition CPU clock speed. Constraints N/A Range N/A Default Value N/A
other_parameters	String	Definition Other parameters. Constraints N/A Range N/A Default Value N/A
serial_number	String	Definition Serial number. Constraints N/A Range N/A Default Value N/A
part_number	String	Definition The part number of the specified CPU resource. Constraints N/A Range N/A Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A
state	String	Definition Hardware status. Constraints N/A Range Enabled Unenabled Unknown Default Value N/A

**Table 7** NetworkAdapter
Parameter	Type	Description
name	String	Definition Network adapter name. Constraints N/A Range N/A Default Value N/A
card_model	String	Definition Chip model of a network adapter. Constraints N/A Range N/A Default Value N/A
model	String	Definition Network adapter model. Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Manufacturer of a network adapter. Constraints N/A Range N/A Default Value N/A
card_manufacturer	String	Definition Chip manufacturer of a network adapter. Constraints N/A Range N/A Default Value N/A
position	String	Definition Network adapter position. Constraints N/A Range N/A Default Value N/A
slot_number	Integer	Definition Network adapter slot number. Constraints N/A Range N/A Default Value N/A
pcb_version	String	Definition PCB version of a network adapter. Constraints N/A Range N/A Default Value N/A
driver_name	String	Definition Driver name of the network adapter. Constraints N/A Range N/A Default Value N/A
driver_version	String	Definition Driver version of the network adapter. Constraints N/A Range N/A Default Value N/A
associated_resource	String	Definition Associated resource of a network adapter. Constraints N/A Range N/A Default Value N/A
firmware_version	String	Definition Firmware version of a network adapter. Constraints N/A Range N/A Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A
network_ports	Array of NetworkPort objects	Definition Network port list. Constraints N/A

**Table 8** NetworkPort
Parameter	Type	Description
physical_port_number	String	Definition Physical port number of a network port. Constraints N/A Range N/A Default Value N/A
link_status	String	Definition Physical connection status of a network port. Constraints N/A Range Up: Connected Down: Disconnected Default Value N/A
associated_network_addresses	String	Definition Network address of a network port. Constraints N/A Range N/A Default Value N/A
active_link_technology	String	Definition Network protocol of a network port. Constraints N/A Range N/A Default Value N/A
port_type	String	Definition Network port type. Constraints N/A Range N/A Default Value N/A
port_max_speed	String	Definition Maximum rate of a network port. Constraints N/A Range N/A Default Value N/A
firmware_package_version	String	Definition Firmware version of a network port. Constraints N/A Range N/A Default Value N/A
bdf	String	Definition BDF of a network port. Constraints N/A Range N/A Default Value N/A
auto_neg	String	Definition Protocol. Constraints N/A Range N/A Default Value N/A
permanent_mac_address	String	The server MAC address

**Table 9** Fan
Parameter	Type	Description
name	String	Definition Fan name. Constraints N/A Range N/A Default Value N/A
model	String	Definition Fan model. Constraints N/A Range N/A Default Value N/A
reading	Integer	Definition Fan rotational speed. Constraints N/A Range N/A Default Value N/A
reading_units	String	Definition Units for the fan rotational speed. Constraints N/A Range N/A Default Value N/A
part_number	String	Definition Fan firmware code. Constraints N/A Range N/A Default Value N/A
speed_ratio	Integer	Definition Fan speed ratio. Constraints N/A Range N/A Default Value N/A
status	Status object	Hardware status.

**Table 10** Power
Parameter	Type	Description
name	String	Definition Power supply name. Constraints N/A Range N/A Default Value N/A
slot_number	Integer	Definition Power supply slot number. Constraints N/A Range N/A Default Value N/A
model	String	Definition Power supply model. Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Power supply vendor. Constraints N/A Range N/A Default Value N/A
power_supply_type	String	Definition Input mode. Constraints N/A Range N/A Default Value N/A
power_capacity_watts	Integer	Definition Rated power. Constraints N/A Range N/A Default Value N/A
line_input_voltage	Integer	Definition Input voltage. Constraints N/A Range N/A Default Value N/A
output_voltage	Integer	Definition Output voltage. Constraints N/A Range N/A Default Value N/A
protocol	String	Definition Protocol. Constraints N/A Range N/A Default Value N/A
active_standby	String	Definition Active/Standby mode. Constraints N/A Range N/A Default Value N/A
part_number	String	Definition Component No. Constraints N/A Range N/A Default Value N/A
serial_number	String	Definition Serial number. Constraints N/A Range N/A Default Value N/A
firmware_version	String	Definition Firmware version. Constraints N/A Range N/A Default Value N/A
status	Status object	Hardware status overview.

**Table 11** Status
Parameter	Type	Description
state	String	Definition Hardware status. Constraints N/A Range Enabled Unenabled Unknown Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A

**Table 12** StorageController
Parameter	Type	Description
name	String	Definition Name of a storage controller. Constraints N/A Range N/A Default Value N/A
model	String	Definition Storage controller model. Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Storage controller manufacturer. Constraints N/A Range N/A Default Value N/A
state	String	Definition Hardware status. Constraints N/A Range Enabled Unenabled Unknown Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A
type	String	Definition Storage controller type. Constraints N/A Range N/A Default Value N/A
firmware_version	String	Definition Firmware version. Constraints N/A Range N/A Default Value N/A
supported_raid_levels	Array of strings	Definition The list of supported RAID levels. Constraints N/A
mode	String	Definition Storage controller mode. Constraints N/A Range N/A Default Value N/A
configuration_version	String	Definition Storage controller configuration version. Constraints N/A Range N/A Default Value N/A
sas_address	String	Definition SAS address. Constraints N/A Range N/A Default Value N/A
capacitance_name	String	Definition Name of a storage controller BBU. Constraints N/A Range N/A Default Value N/A
capacitance_state	String	Definition Status of a storage controller BBU. Constraints N/A Range N/A Default Value N/A
capacitance_health	String	Definition Health status of a storage controller BBU. Constraints N/A Range N/A Default Value N/A
min_stripe_size_bytes	Long	Definition The minimum stripe size supported by a controller. Constraints N/A Range N/A Default Value N/A
max_stripe_size_bytes	Long	Definition The maximum stripe size supported by a controller. Constraints N/A Range N/A Default Value N/A
volumes	Array of Volume objects	Definition Logical disk list. Constraints N/A
drives	Array of strings	Definition List of managed drives. Constraints N/A

**Table 13** Volume
Parameter	Type	Description
name	String	Definition Name of a logical disk. Constraints N/A Range N/A Default Value N/A
volume_raid_level	String	Definition RAID level. Constraints N/A Range N/A Default Value N/A
capacity_bytes	Integer	Definition Capacity (unit: byte). Constraints N/A Range N/A Default Value N/A
optimum_io_size_bytes	Integer	Definition Stripe size of a logical disk (unit: byte). Constraints N/A Range N/A Default Value N/A
current_read_policy	String	Definition Current read policy. Constraints N/A Range N/A Default Value N/A
default_read_policy	String	Definition Default read policy. Constraints N/A Range N/A Default Value N/A
current_write_policy	String	Definition Current write policy. Constraints N/A Range N/A Default Value N/A
default_write_policy	String	Definition Default write policy. Constraints N/A Range N/A Default Value N/A
access_policy	String	Definition Access policy. Constraints N/A Range N/A Default Value N/A
current_io_policy	String	Definition Current I/O policy. Constraints N/A Range N/A Default Value N/A
default_io_policy	String	Definition Default I/O policy. Constraints N/A Range N/A Default Value N/A
drives	Array of Drive objects	Definition Details about physical disks. Constraints N/A
status	VolumeStatus object	Logical volume status overview.

**Table 14** Drive
Parameter	Type	Description
id	String	Definition Drive ID. Constraints N/A Range N/A Default Value N/A
name	String	Definition Drive name. Constraints N/A Range N/A Default Value N/A
manufacturer	String	Definition Manufacturer of the drive. Constraints N/A Range N/A Default Value N/A
model	String	Definition Drive model. Constraints N/A Range N/A Default Value N/A
serial_number	String	Definition Serial number of the drive. Constraints N/A Range N/A Default Value N/A
revision	String	Definition Drive version. Constraints N/A Range N/A Default Value N/A
media_type	String	Definition Media type of the drive. Constraints N/A Range N/A Default Value N/A
protocol	String	Definition Protocol that the drive complies with. Constraints N/A Range N/A Default Value N/A
sas_address	String	Definition SAS address. Constraints N/A Range N/A Default Value N/A
capacity_bytes	Integer	Definition Capacity (unit: byte). Constraints N/A Range N/A Default Value N/A
capable_speed_gbs	Integer	Definition Maximum rate of the drive interface (unit: Gbit/s). Constraints N/A Range N/A Default Value N/A
negotiated_speed_gbs	Integer	Definition Negotiated rate of the drive interface (unit: Gbit/s). Constraints N/A Range N/A Default Value N/A
hotspare_type	String	Definition Hot spare status of the drive. Constraints N/A Range N/A Default Value N/A
hours_of_powered_up	Integer	Definition Power-on duration of the drive (unit: hour). Constraints N/A Range N/A Default Value N/A
power_state	String	Definition Drive power status. Constraints N/A Range N/A Default Value N/A
patrol_state	String	Definition Drive inspection status. Constraints N/A Range N/A Default Value N/A
associated_resource	String	Definition Associated resource of the drive. Constraints N/A Range N/A Default Value N/A
predicted_media_life_left_percent	Integer	Definition Drive remaining lifetime (percentage). Constraints N/A Range N/A Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A

**Table 15** VolumeStatus
Parameter	Type	Description
state	String	Definition The logic volume status. Constraints N/A Range Common values: Enabled, Disabled, StandbyOffline, UnavailableOffline, InTest, Starting, Absent, Updating, and Optimal. This field can be extended. Default Value N/A
health	String	Definition Hardware health status. Constraints N/A Range OK Warning Critical Unknown The system detects potential problems or minor exceptions. The server can still run properly, but the risk increases. The system detects a severe hardware fault or an extreme exception. The problem has affected the stability, performance, or availability of the server. The health status cannot be detected. The status is unknown. Default Value N/A

**Table 16** HardwareMetric
Parameter	Type	Description
metric_name	String	Definition Metric name. Constraints N/A Range N/A Default Value N/A
metric_devices	Array of strings	Definition Monitoring metric object. Constraints N/A Range N/A Default Value N/A

Status code: 400

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 401

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 429

**Table 19** Response body parameters
Parameter	Type	Description
-	String

Status code: 500

**Table 20** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Example Requests

Querying server hardware details

GET https://{endpoint}/v1/{project_id}/physicalservers/{id}/hardware-attributes

Example Responses

Status code: 200

Hardware details are returned.

{
  "summary" : {
    "sn" : "2102314JLR10NA100021",
    "manufacturer" : "Huawei",
    "model" : "NV602x1x99x3",
    "main_board_manufacturer" : "Huawei"
  },
  "memorys" : [ {
    "name" : "mainboardDIMM000",
    "manufacturer" : "Samsung",
    "capacity_mib" : 32768,
    "memory_device_type" : "DDR4",
    "allowed_speed_mhz" : 2933,
    "serial_number" : "136BF0FB",
    "data_width_bits" : 72,
    "rank_count" : 2,
    "part_number" : "M393A4K40CB2-CVF",
    "min_voltage_millivolt" : 1200,
    "position" : "mainboard",
    "bom_number" : "",
    "type_detail" : "Synchronous| Registered (Buffered)",
    "technology" : "DRAM",
    "operating_speed_mhz" : 2933,
    "state" : "Enabled",
    "health" : ""
  } ],
  "processors" : [ {
    "name" : "CPU1",
    "manufacturer" : "CPU1",
    "total_enabled_cores" : 0,
    "health" : "",
    "state" : "Enabled",
    "other_parameters" : "64-bit Capable| Multi-Core| Hardware Thread| Execute Protection| Enhanced Virtualization| Power/Performance Control",
    "serial_number" : "21B4118D798F0112",
    "total_enabled_threads" : 0,
    "total_cores" : 26,
    "total_threads" : 52,
    "model" : "Intel(R) Xeon(R) Gold 6278C CPU @ 2.60GHz",
    "max_speed_mhz" : 2600,
    "l1_cache_kib" : 1664,
    "l2_cache_kib" : 26624,
    "l3_cache_kib" : 36608,
    "socket" : 0,
    "temperature" : 0,
    "frequency_mhz" : 2600
  } ],
  "network_adapters" : [ {
    "name" : "LOM",
    "model" : "X722",
    "manufacturer" : "Intel",
    "card_manufacturer" : "Huawei",
    "position" : "",
    "slot_number" : 0,
    "pcb_version" : ".B",
    "driver_name" : "",
    "driver_version" : "",
    "associated_resource" : "CPU1",
    "firmware_version" : "",
    "health" : "OK",
    "network_ports" : [ {
      "physical_port_number" : "1",
      "link_status" : "Down",
      "associated_network_addresses" : "C8:A7:76:82:30:3E",
      "active_link_technology" : "Ethernet",
      "port_type" : "",
      "auto_neg" : "",
      "port_max_speed" : "10GE",
      "firmware_package_version" : "",
      "bdf" : "0000:1a:00.0"
    } ]
  } ],
  "fans" : [ {
    "name" : "Fan1",
    "model" : "02311VSF 8038+",
    "reading" : 0,
    "reading_units" : "RPM",
    "part_number" : "02311VSF",
    "speed_ratio" : 0,
    "status" : {
      "state" : "Enabled",
      "health" : "OK"
    }
  } ],
  "storage_controllers" : [ {
    "name" : "RAIDStorage0",
    "type" : "SAS3508",
    "model" : "",
    "manufacturer" : "Broadcom",
    "state" : "Enabled",
    "health" : "",
    "min_stripe_size_bytes" : 0,
    "max_stripe_size_bytes" : 0,
    "firmware_version" : "",
    "supported_raid_levels" : [ "RAID0", "RAID1", "RAID5", "RAID6", "RAID10", "RAID50", "RAID60" ],
    "mode" : "N/A",
    "configuration_version" : "",
    "sas_address" : "",
    "capacitance_name" : "",
    "capacitance_state" : "Enabled",
    "capacitance_health" : "OK",
    "volumes" : null,
    "drives" : [ "HDDPlaneDisk0", "HDDPlaneDisk1" ]
  } ],
  "powers" : [ {
    "name" : "PSU1",
    "slot_number" : 1,
    "model" : "PAC1500S12-BE",
    "manufacturer" : "HUAWEI",
    "power_supply_type" : "AC",
    "power_capacity_watts" : 1500,
    "line_input_voltage" : 228,
    "output_voltage" : 7,
    "protocol" : "",
    "active_standby" : "Active",
    "part_number" : "02312DAE",
    "serial_number" : "2102312DAEHVK4001029",
    "firmware_version" : "DC:107 PFC:107",
    "status" : {
      "state" : "Enabled",
      "health" : "OK"
    }
  } ],
  "metrics" : [ {
    "metric_name" : "cpu_health",
    "metric_devices" : [ "CPU1" ]
  } ]
}

Status Codes

Status Code	Description
200	Hardware details are returned.
400	Invalid request parameter.
401	The request is not authenticated.
429	The request is overloaded.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic:Physical Server Management

Previous topic: Obtaining the Console Address

Next topic: Querying the Firmware Details

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot