接口功能介绍
本接口用于查询指定设备的服务配置列表，包含视频、视图和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"}}
状态码
请参考 状态码
错误码
请参考 错误码
