Query Hardware Information by Product ID

Last Updated on : 2023-06-20 12:39:05

Query the hardware information of a specified product based on the product ID. For example, the electronic components used in the product, and the firmware information to be flashed on the components, such as the key, version number, over-the-air (OTA) channel number, and unique identifier of the firmware.

API address

GET: /v1.0/iot-03/product/hardwares

Request parameter

Parameter name	Type	IN	Required	Description
product_id	String	query	true	The product ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
product_hardware_struct_list	List	The list of product hardware structures.
component_code	String	The code of a specified component.

Description of product_hardware_struct_list

Parameter name	Type	Description
firmware_key	String	The firmware key.
firmware_version	String	The firmware version.
ota_channel	Integer	The OTA channel number.
firmware_id	Long	The firmware ID.

Request example

GET: /v1.0/iot-03/product/hardwares

{
  "product_id": "***pid"
}

Return example

{
    "result": {
        "product_hardware_struct_list": [
            {
                "firmware_key": "key***",
                "firmware_id": 999,
                "firmware_version": "1.0.0",
                "ota_channel": 0
            }
        ],
        "component_code": "WB3S"
    },
    "t": 1545278901275,
    "success": true
}

Error code

For more information, see error code.