調用該接口獲取用戶綁定的設備列表信息。

路徑 /uc/listBindingByAccount
版本號 1.0.8
協議 HTTPS
請求方法 POST
是否需要用戶身份鑒權
超時時間 8000

請求參數

名稱 類型 是否必選 示例值 描述
thingType String DEVICE 待查詢設備的類型。取值為:VIRTUAL(表示虛擬設備);DEVICE(表示普通設備);WEB;APP。
nodeType String GATEWAY 要查詢的設備的節點類型。取值為:DEVICE(表示設備);GATEWAY(表示網關)。
pageNo Int 1 當前頁碼,從1開始。
pageSize Int 100 分頁大小,大于等于1,小于等于100。
owned Int 0 綁定類型。取值為:0(表示被分享的設備);1(表示擁有的設備);null(表示所有的設備)。
groupId String value 要查詢的空間,如家ID、房間ID等。
isSubDevice Boolean true 是否為子設備。歸屬在某一個網關設備下的設備表示為子設備。取值為:true (表示獲取子設備列表);false (表示獲取直連設備列表)。

返回數據

名稱 類型 示例值 描述
total Long

滿足條件的設備總數。

pageNo Int

分頁頁碼。

pageSize Int

分頁大小。

data JSON

設備的詳情列表。

identityId String

用戶的身份ID。

iotId String

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

deviceName String

設備的名稱,設備證書信息之一。在注冊設備時,自定義的或系統生成的設備名稱,具備產品維度內的唯一性。

productKey String

產品的Key,設備證書信息之一。創建產品時,生活物聯網平臺為該產品頒發的全局唯一標識。

productName String

設備所屬產品的名稱。

productImage String

設備所屬產品的圖標,如果未定義產品圖標,該字段和categoryImage字段一致。

productModel String

設備所屬產品的型號。

categoryImage String

設備所屬產品品類的圖標。

nickName String

設備的昵稱,可為空。

netType String

產品下設備的聯網方式,可取值: NET_LORA(表示LoRa);NET_CELLULAR(表示2G/3G/4G/5G蜂窩網);NET_WIFI(表示Wi-Fi);NET_ZIGBEE(表示ZigBee);NET_ETHERNET(表示以太網);NET_OTHER(表示其他網絡類型)。

thingType String

設備的類型,根據在生活物聯網平臺創建設備的方式決定,一般正式量產的設備為DEVICE類型, 可取值: VIRTUAL(表示虛擬設備);VIRTUAL_SHADOW(表示虛擬影子設備);DEVICE(表示普通設備)。

status Int

設備狀態。0(表示未激活);1(表示在線);3(表示離線);8(表示禁用)。

owned Int

設備和用戶的關系,可取值:0(表示分享者),1(表示擁有者)。

nodeType String

設備的節點類型,可取值包括:DEVICE,GATEWAY。

identityAlias String

用戶的顯示名,mobile 或 loginName 或 email。

subDevice Boolean

標識是否為子設備,true(表示為子設備),false 或者 null(表示為直連設備)。

gmtModified Long

綁定設備的時間。

示例

請求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.8",
		"iotToken": "token"
	},
	"params":{
		"thingType": "DEVICE",
		"nodeType": "GATEWAY",
		"pageNo":1,
		"pageSize":100,
		"owned":0,
		"groupId": "value",
		"isSubDevice":true
	}
}

正常返回示例

JSON格式

{
    "id":"4de2c367-c1db-417c-aa15-8c585e595d92",
    "code":200,
    "message":null,
    "localizedMsg":null,
    "data":{
        "total":2,
        "pageId":1,
        "pageSize":10,
        "data":[
            {
                "identityId":"xxx",
                "iotId":"edwB6TqvOW2iXnmY7TNa000100",
                "deviceName":"攝像頭1",
                "productKey":"產品 pk",
                "productName":"產品名稱",
                "productImage":"產品圖片",
                "productModel":"產品型號",
                "categoryKey":"Camera",
                "categoryImage":"xxx",
                "panelPageRouterUrl":"xxx",
                "nickName":"設備昵稱",
                "netType":"NET_WIFI",
                "thingType":"DEVICE",
                "status":1,
                "owned":1,
                "nodeType":"DEVICE",
                "identityAlias":"133xxx",
                "isSubDevice":false,
                "gmtModified":"xxx"
            },
            {
                "identityId":"xxx",
                "iotId":"xadqskpHGoswW8loL89h000100",
                "deviceName":"攝像頭2",
                "productKey":"產品 pk",
                "productName":"產品名稱",
                "productImage":"產品圖片",
                "productModel":"產品型號",
                "categoryKey":"Camera",
                "categoryImage":"xxx",
                "panelPageRouterUrl":"xxx",
                "nickName":"設備昵稱",
                "netType":"NET_WIFI",
                "thingType":"DEVICE",
                "status":1,
                "owned":1,
                "nodeType":"DEVICE",
                "identityAlias":"133xxx",
                "isSubDevice":false,
                "gmtModified":"xxx"
            }
        ]
    }
}

異常返回示例

JSON格式

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