Querying the Physical Server Information
Function
This API is used to query the physical server information.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/physicalservers/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition The project ID. Constraints N/A Range The 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
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
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Server ID. Constraints N/A Range Its value is in UUID format. Default Value N/A |
name |
String |
Definition Name of a physical server, which is used as the hostname when an instance is created. Constraints N/A Range N/A Default Value N/A |
project_id |
String |
Definition The project ID. Constraints N/A Range The project ID of the account Default Value N/A |
domain_id |
String |
Definition domain ID Constraints N/A Range N/A Default Value N/A |
manage_state |
String |
Definition Server management status. Constraints N/A Value Range
Default Value N/A |
power_state |
String |
Definition Power supply status. The power_state value changes according to different operations and events. The common status transition process is as follows: Constraints N/A Range
Example scenario: After a user creates and activates a node in Ironic or powers on a node, the power_state value of the node changes to power on. Example scenario: When a node is under maintenance or is no longer used, the administrator can power off the node. In this case, power_state is power off. Example scenario: When an administrator uses the Ironic API to reboot a node, its power_state changes to rebooting during the process. Example scenario: After an administrator sends a power-on instruction, the node enters the powering on state. The power_state value changes to power on when the OS has been started. Example scenario: After an administrator sends a power-off instruction, the node enters the powering off state. The power_state value changes to off when the power supply is completely turned off. Default Value N/A |
health_state |
String |
Definition Hardware health status. Constraints N/A Range Default Value N/A |
onboard_time |
String |
Definition Provisioning time. Constraints N/A Range The value is in RFC 3339 format, for example, 2025-04-22T12:03:18.50083+08:00. Default Value N/A |
location |
Location object |
Definition Location of the physical server. Constraints N/A |
hardware_attributes |
HardwareSummary object |
Definition Hardware overview information, including the server manufacturer, model, and serial number. Constraints N/A |
tags |
Array of Tag objects |
Definition Tag. Constraints N/A |
error |
ErrorStatus object |
Definition Error object returned upon a failure. Constraints N/A |
Parameter |
Type |
Description |
---|---|---|
dc |
String |
Definition Equipment room name. Constraints N/A Range Maximum length: 256 bytes. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. Default Value N/A |
rack |
String |
Definition Rack name. Constraints N/A Range Maximum length: 128 bytes. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. It cannot start with hyphens (-) or periods (.). Default Value N/A |
unit |
String |
Definition Rack unit (U) Constraints N/A Range Maximum length: 128 bytes Default Value N/A |
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 |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
error_type |
String |
Definition Error type. Constraints N/A Range Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
- |
String |
- |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Example Request
Request for querying information about physical servers
GET https://{endpoint}/v1/{project_id}/physicalservers/{id}
Example Response
Status code: 200
Physical server information returned.
{ "id" : "0197ee54-53de-78fe-94dd-a6684e4a85ee", "name" : "CloudDC-Jarvis-147", "project_id" : "e750c9499ffb4244add7398a0af4f215", "domain_id" : "aef171e13fe24458a819bb42870571d9", "manage_state" : "ready", "power_state" : "off", "health_state" : "OK", "onboard_time" : "2025-07-09T16:36:33.374276+08:00", "location" : { "dc" : "BBB", "rack" : "AAA", "unit" : "19" }, "hardware_attributes" : { "sn" : "CloudDC-Jarvis-147", "manufacturer" : "Huawei", "model" : "NV602x1x99x3" }, "tags" : [ { "key" : "chennantest", "value" : "1223" }, { "key" : "QQ", "value" : "QQ" } ], "ops_result" : "Uninstalling", "az_id" : "", "region_id" : "", "bmc_firmware_version" : "" }
Status Codes
Status Code |
Description |
---|---|
200 |
Physical server information returned. |
400 |
Invalid request parameter. |
401 |
The request is not authenticated. |
429 |
The request is overloaded. |
500 |
Internal server error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot