接口功能介绍
本接口用于查询存储模板下绑定的设备列表。
接口约束
查询前确保存在该存储模板。
请求参数说明：
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"}}
状态码
请参考 状态码
错误码
请参考 错误码
