查詢設備資源列表
更新時間 2024-09-11 16:11:36
最近更新時間: 2024-09-11 16:11:36
分享文章
接口功能介紹
本接口用于查詢指定設備的服務配置列表，包含視頻、視圖和AI配置等。
接口約束
需要確認存在該設備。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/device/*/resource/list
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 設備ID。 | 32388487739092996 |
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DeviceType | 是 | String | 設備類型，需與查詢的DeviceId真實設備類型一致。取值：ipc，nvr。 | ipc |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| Resource | Object | 資源信息。 | Resource | |
| RequestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b |
表 Resource
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| Video | Array of Objects | 視頻資源。 | Video | |
| Viid | Array of Objects | 視圖資源。 | Viid | |
| AI | Array of Objects | AI資源。 | AI |
表 Video
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ChannelNum | String | 通道號。 | 1 | |
| ChannelName | String | 通道名稱。 | 通道1 | |
| WorkOrderNo | String | 訂單號。 | 202211031607018234 | |
| WorkOrderId | String | 訂單ID。 | work_order_20723343 | |
| BillingMode | String | 計費模式。取值：packages(資源包)，onDemand(按需計費)，unBinding(停用)。 | packages | |
| ResourceId | String | 資源ID。 | resource20723343 | |
| RecordNum | String | 錄制配置，取值：0：無錄制；1：錄制。 | 1 | |
| TemplateId | String | 錄制模板ID。 | 717074786139029504 | |
| TotalDeviceCount | String | 設備總路數。 | 100 | |
| RemainDeviceCount | String | 設備剩余路數。 | 100 | |
| CodeRate | String | 碼率。 | 8 | |
| StorageTime | String | ST_天數 。 | ST_3 | |
| BandWidth | String | 總帶寬。 | 100 | |
| IsTrialOrder | String | 是否試用。取值：0(代表商用)，1(代表試用)。 | 0 | |
| CreateTime | String | 創建時間。 | 2022-11-25 16:03:04 | |
| ExpireTime | String | 失效時間。 | 2024-12-01 10:55:04 |
表 Viid
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ChannelNum | String | 通道號。 | 1 | |
| ChannelName | String | 通道名稱。 | 通道1 | |
| WorkOrderNo | String | 訂單號。 | 202211031607018234 | |
| WorkOrderId | String | 訂單ID。 | work_order_20723343 | |
| BillingMode | String | 計費模式。取值：onDemand(按需計費)，unBinding(停用)。 | onDemand | |
| ResourceId | String | 資源ID。 | resource20723343 | |
| RecordNum | String | 錄制配置，取值：0：無錄制；1：錄制。 | 1 | |
| TemplateId | String | 錄制模板ID。 | 717074786139029504 | |
| IsTrialOrder | String | 是否試用。取值：0(代表商用)，1(代表試用)。 | 0 | |
| CreateTime | String | 創建時間。 | 2022-11-25 16:03:04 | |
| ExpireTime | String | 失效時間。 | 2024-12-01 10:55:04 |
表 AI
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| WorkOrderNo | String | 訂單號。 | 202211031607018234 | |
| WorkOrderId | String | 訂單ID。 | work_order_20723343 | |
| BillingMode | String | 計費模式。取值：packages(資源包)，onDemand(按需計費)，unBinding(停用)。 | packages | |
| ResourceId | String | 資源ID。 | resource20723343 | |
| AppId | String | AI應用id。 | 1 | |
| AppName | String | 應用名。 | 人臉識別 | |
| AlgorithmType | String | 算法類型。 | 吸煙檢測 | |
| AnalysisType | String | 分析類型。 | AI-100 | |
| ConfigCheckArea | String | 配置檢查區域。 | false | |
| TotalDeviceCount | String | 設備總路數。 | 100 | |
| RemainDeviceCount | String | 設備剩余路數。 | 100 | |
| Status | String | 是否啟動算法。 | 1 | |
| CreateTime | String | 創建時間。 | 2022-11-25 16:03:04 | |
| ExpireTime | String | 失效時間。 | 2024-12-01 10:55:04 |
枚舉參數
無
請求示例
請求url
GET '/v2/device/32388487739092996/resource/list'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "4fd04ee0745f4f7f8a1f207026b358e3","returnObj": {"Resource": {"Video": [{"BillingMode": "packages","ChannelNum": "-1","ChannelName": "rtsp-ipc","WorkOrderNo": "202211031607018234","WorkOrderId": "work_order_20723343","ResourceId": "resource20723343","TotalDeviceCount": "300","RemainDeviceCount": "284","CodeRate": "8","StorageTime": "ST_3","IsTrialOrder": "0","BandWidth": "0","CreateTime": "2022-11-25 16:03:04","ExpireTime": "2024-12-01 10:55:04","RecordNum": "0","TemplateId": "0"}],"Viid": [],"AI": []},"RequestId": "4fd04ee0745f4f7f8a1f207026b358e3"}}
狀態碼
請參考
錯誤碼
請參考
