獲取項目下所有已綁定空間的設備信息

路徑 /campus/paas/openapi/space/device/list
版本號 1.8.0
協議 HTTPS
請求方法 POST
是否需要用戶身份鑒權 否
超時時間 10000

請求參數

名稱 類型 是否必選 示例值 描述
appId String 否 d64fff*****34e8d9bf40a16065d59b3 應用實例唯一id
pageNo Int 是 1 當前頁碼
pageSize Int 是 1 每頁條數
categoryKey String 否 產品分類key
spaceId String 否 空間ID過濾條件，搜索當前空間及所有下級空間
match String 否 match為true 就是返回這個空間下的數據 如果為false或者不傳，則查當前空間以及子空間下的所有設備

返回數據

名稱 類型 示例值 描述
code Int

響應碼, 200: 成功
message String

錯誤消息
localizedMsg String

本地語言錯誤消息
data JSON

返回結果數據
total Long

總條數
pageNo Long

當前頁碼
pageSize Long

每頁條數
data JSON

結果集合
productName String

產品名稱
productKey String

產品productKey
deviceName String

設備deviceName
categoryKey String

設備類型（如Gateway代表網關）
namePath String

設備綁定空間位置
iotId String

設備id
path String

空間id的路徑
spaceId String

空間id
deviceStatus String

設備狀態：0

  • 未激活， 1
  • 在線， 3
  • 離線， 8
  • 禁用
memoName String

設備備注名

示例

請求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.8.0"
	},
	"params":{
		"appId": "d64fff*****34e8d9bf40a16065d59b3",
		"pageNo":1,
		"pageSize":1,
		"categoryKey": "value3",
		"spaceId": "value4",
		"match": "value5"
	}
}

正常返回示例

JSON 格式 

{
    "code": 200,
    "data": {
        "data": [
            {
                "categoryKey": "Gateway",
                "deviceName": "xxxx*****x",
                "productKey": "xxxx*****x",
                "productName": "xxxxx*****",
                "spacePath": "/xxxxxxxxxx/xxxxxxxxxx/"
            },
            {
                "categoryKey": "Curtain",
                "deviceName": "xxxxx*****",
                "productKey": "xxxxx*****",
                "productName": "xxxxx*****",
                "spacePath": "/xxxxx*****/xxxxx*****/"
            }
        ],
        "pageNo": 1,
        "pageSize": 20,
        "total": 100
    },
    "message": "success"
}

異常返回示例

JSON 格式 

{
    "code": 28402,
    "localizedMsg": "無權訪問該項目",
    "message": "no access to the project"
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 2459 oa error message 會話Id不存在
200 2459 oa error message 會話Id不存在
200 2402 iotToken not exist
200 2402 iotToken not exist
200 2401 refreshToken invalid refreshToken已經失效
200 2401 refreshToken invalid refreshToken已經失效