獲取某一個設備的固件升級進度等信息，可以指定具體的子模塊名稱和固件版本號。當指定了具體的子模塊和固件版本號時，如果存在對應固件，則返回該固件的升級進度等信息。

路徑 /living/ota/progress/get
版本號 1.0.0
協議 HTTPS
請求方法 POST
是否需要用戶身份鑒權 是
超時時間 3000

請求參數

名稱 類型 是否必選 示例值 描述
iotId String 否 7bvbyRItBXQxxxxxxQt9X00109ea700 設備的ID，生活物聯網平臺為設備頒發的ID，設備的唯一標識符。產品的Key或設備名稱為空時，該參數不允許為空。設備ID、產品的Key和設備名稱若同時填寫，以設備ID為準。
productKey String 否 a1LxxxxXUqY 產品的Key，設備證書信息之一。創建產品時，生活物聯網平臺為該產品頒發的全局唯一標識。設備ID為空時，該參數不允許為空。設備ID、產品的Key和設備名稱若同時填寫，以設備ID為準。
deviceName String 否 wt0jxxxxxxxnU0pc4AHX 設備的名稱，設備證書信息之一。在注冊設備時，自定義的或系統生成的設備名稱，具備產品維度內的唯一性。設備ID為空時，該參數不允許為空。設備ID、產品的Key和設備名稱若同時填寫，以設備ID為準。
moduleName String 否 default 設備子模塊的名稱，控制臺的OTA固件上傳界面，在操作固件上傳時輸入的子模塊名稱。入參為空時，則表示獲取默認的default模塊。
currentVersion String 否 v1.0.0 當前設備子模塊的固件版本信息，不為空時云端會以該版本信息作為設備當前子模塊的實際版本進行邏輯處理。
firmwareVersion String 否 v1.0.0 固件的版本號。可以通過獲取設備當前可用的固件信息接口獲取。當子模塊名稱不為空并且不是default時，該入參不允許為空。

返回數據

名稱 類型 示例值 描述
code Int

接口返回碼。200表示成功。
message String

調用失敗時，返回的出錯信息。
localizedMsg String

本地語言的錯誤消息。
data JSON

調用成功時，返回固件升級進度信息。
iotId String

設備的ID，生活物聯網平臺為設備頒發的ID，設備的唯一標識符。
moduleName String

設備子模塊的名稱，控制臺的OTA固件上傳界面，在操作固件上傳時輸入的子模塊名稱。
currentVersion String

當前設備子模塊的固件版本信息。
firmwareVersion String

固件文件對應的版本號。
otaType String

固件信息的推送類型，可取值：CONFIRM（用戶確認升級）； COMPELLENT（強制升級）。固件升級狀態為TO_BE_UPGRADED時該參數有效。
needConfirm Boolean

是否需要用戶進行確認操作，可取值：true（表示需要進行確認操作）； false（表示不需要進行確認操作）。otaType為CONFIRM時有效。
status String

固件升級狀態。可取值： TO_BE_UPGRADED（表示待升級）；UPGRADING（表示升級中）；SUCCEEDED（表示升級成功）；FAILED（表示升級失敗）。注意：如果升級時間超過10分鐘（從在平臺創建升級任務開始計算）還處于升級中，就返回upgradeStatus為2。
step Int

升級進度百分比，當升級失敗時該參數為負數。
desc String

固件進度的描述信息。

示例

請求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0",
		"iotToken": "token"
	},
	"params":{
		"iotId": "7bvbyRItBXQxxxxxxQt9X00109ea700",
		"productKey": "a1LxxxxXUqY",
		"deviceName": "wt0jxxxxxxxnU0pc4AHX",
		"moduleName": "default",
		"currentVersion": "v1.0.0",
		"firmwareVersion": "v1.0.0"
	}
}

正常返回示例

JSON格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c5xxxxd92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "moduleName": "default",
        "currentVersion": "1.0.1-2020030301",
        "firmwareVersion": "1.0.1",
        "step": 10,
        "desc": "xxxxxx",
        "otaType": "CONFIRM",
        "needConfirm": true,
        "status": "UPGRADING"
    }
}

異常返回示例

JSON格式 

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bfxxxx284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "請求被禁止",
    "data": null
}