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

Querying the Firmware Details

Function

This API is used to obtain firmware details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/physicalservers/{id}/firmware-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

[items]

Array of FirmwareDetails objects

Definition

The list of firmware details.

Constraints

N/A

Table 4 FirmwareDetails

Parameter

Type

Description

component_name

String

Definition

Component name.

Constraints

N/A

Range

N/A

Default Value

N/A

model

String

Definition

Model.

Constraints

N/A

Range

N/A

Default Value

N/A

manufacturer

String

Definition

Manufacturer.

Constraints

N/A

Range

N/A

Default Value

N/A

version

String

Definition

Version.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 429

Table 7 Response body parameters

Parameter

Type

Description

-

String

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Example Requests

Querying firmware details

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

Example Responses

Status code: 200

Firmware details are returned.

[ {
  "component_name" : "ActiveBMC",
  "model" : "BMC-iBMC",
  "manufacturer" : "Huawei",
  "version" : "6.68"
} ]

Status Codes

Status Code

Description

200

Firmware 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.