查詢存儲模板綁定的設備列表
更新時間 2024-09-11 16:11:26
最近更新時間: 2024-09-11 16:11:26
分享文章
接口功能介紹
本接口用于查詢存儲模板下綁定的設備列表。
接口約束
查詢前確保存在該存儲模板。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/recordTemplates/*/binds
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| RecordTemplateId | 是 | String | 模板id | 717074786139029504 |
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| InProtocol | 否 | String | 使用的接入協議，默認gb28181。取值：gb28181，rtmp，rtsp，onvif，ehome。 | gb28181 | |
| SortBy | 否 | String | 選擇按一個字段排序，默認為CreatedTime，按照創建時間排序。取值：CreatedTime：創建時間；UpdatedTime：更新時間； | CreatedTime | |
| SortDirection | 否 | String | 排序方式，默認升序。取值：asc：升序；desc：降序； | asc | |
| PageNum | 否 | Integer | 第幾個分頁，默認為1。 | 1 | |
| PageSize | 否 | Integer | 分頁大小，默認為20，取值范圍為1～1000。 | 20 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| PageNum | Integer | 第幾個分頁 | 1 | |
| PageSize | Integer | 分頁大小 | 10 | |
| TotalPage | Integer | 分頁總數 | 1 | |
| TotalNum | Integer | 設備總數 | 10 | |
| Devices | Array of Objects | 設備列表 | Device | |
| RequestId | String | 請求ID | a2b3dc8eb265424c972961f668e6a5ac |
表 Device
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| DeviceId | String | 設備id | 700576974938832896 | |
| DeviceName | String | 設備名稱 | test | |
| CreatedTime | String | 綁定設備創建時間 | 2023-04-18 17:49:23 | |
| UpdatedTime | String | 綁定設備更新時間 | 2023-04-18 17:49:23 |
枚舉參數
無
請求示例
請求url
GET '/v2/recordTemplates/717074786139029504/binds'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "a2b3dc8eb265424c972961f668e6a5ac","returnObj": {"PageNum": 1,"PageSize": 10,"TotalPage": 1,"TotalNum": 1,"Devices": [{"DeviceId": "700576974938832896","DeviceName": "開發自測-08","CreatedTime": "2023-04-18 17:49:23","UpdatedTime": "2023-04-18 17:49:23"}],"RequestId": "a2b3dc8eb265424c972961f668e6a5ac"}}
狀態碼
請參考
錯誤碼
請參考
