功能介绍
默认接口请求频率限制：500次/秒。
查询流URL信息。
接口约束
- 确保查询设备的流已上线。
- 查询vod视频流确保设备具有本地录像功能并有可查询的本地录像。
URI
GET /v1?
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeStreamURL | 操作接口名，系统规定参数。 |
| InProtocol | String | 是 | gb28181 | 使用的接入协议。取值: gb28181, rtmp, rtsp, onvif,ehome，vgroup |
| DeviceId | String | 是 | 32388487739092997 | 设备ID。 |
| OutProtocol | String | 是 | webrtc | 流播放协议，多值用逗号分隔。取值: rtmp, hls, flv, webrtc |
| Type | String | 是 | live | 流类型，默认live。取值：live（直播流）、vod（点播流，例如NVR上的历史流） |
| StartTime | Long | 否 | 1571639499 | 开始时间，适用于vod流类型。unix时间戳，单位秒。 |
| EndTime | Long | 否 | 1571639999 | 结束时间，适用于vod流类型。unix时间戳，单位秒。点播流时，开始时间和结束时间间隔不大于7200秒。 |
| ChannelNum | Long | 否 | 1 | 通道号，适用于ehome协议点播流。 |
| StreamName | String | 否 | 323884892996 | 流名称，适用于ehome协议点播流。 |
| StreamNum | Long | 否 | 1 | 第几个码流，适用于EHOME和RTSP协议直播流。取值:1: 主码流2: 子码流3: 第三码流 |
| FileName | String | 否 | 123xxx | 文件名，适用于ehome协议点播流。 |
| SeekType | Long | 否 | 10 | 搜索类型，默认10，适用于ehome协议点播流。 |
| FileOffset | Long | 否 | 10 | file offset，默认10，适用于ehome协议点播流。 |
| RealGroupId | String | 否 | 208383238668288 | 组ID，适用于vgroup虚拟业务组。 |
| OutNetwork | String | 是 | internet | 播放网络类型，默认internet 取值： internet：互联网； vpn：视频专网 |
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| Video | Video{} | 视频流属性信息。 |
| PushUrl | PushUrl{} | 推流URL。可选项，RTMP或RTSP设备有效。 |
| PlayUrl | PlayUrl{} | 流的播放URL。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| DeviceId | String | 设备ID。可选项，ehome协议有效。 |
| CreatedTime | String | 生成时间。可选项，ehome协议有效。 |
| UpdatedTime | String | 更新时间。可选项，ehome协议有效。 |
| AudioInfo | String | 音频信息 |
| VideoInfo | String | 视频信息 |
Video
| 参数 | 类型 | 描述 |
|---|---|---|
| Codec | String | 编码格式。取值: h264, h265 |
PushUrl
| 参数 | 类型 | 描述 |
|---|---|---|
| RtmpUrl | String[] | rtmp播放url |
PlayUrl
| 参数 | 类型 | 描述 |
|---|---|---|
| RtmpUrl | String | rtmp播放url |
| FlvUrl | String | flv播放url |
| HlsUrl | String | hls播放url |
| WebrtcUrl | String | webrtc播放url |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeStreamURL&DeviceId=29941970440815198&InProtocol=gb28181&OutNetwork=internet&OutProtocol=webrtc&Type=live
Connection: keep-alive
ctyun-eop-request-id: 4504e966-347f-4bcd-bf1e-1bf102555985
Eop-date: 20221025T102809Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=SFOBWtQgUerJkZddryunS+3wbym2kMxWTPsILvfsWZw=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"PlayUrl": {
"FlvUrl": "https://liveplay.vaas.cn-shanghai-1.ctyunxs.cn/live/109185747****.flv",
"HlsUrl": "https://liveplay.vaas.cn-shanghai-1.ctyunxs.cn/live/109185747****/hls.m3u8",
"WebrtcUrl": "webrtc://liveplay.vaas.cn-shanghai-1.ctyunxs.cn/live/109185747****"
},
"Video": {
"Codec": "h264"
},
"RequestId": "bccb8b0cd01d45a0bdb95595761b44aa",
"deviceId": "",
"createdTime": "",
"updatedTime": "",
"VideoInfo": "{\"Bitrate\":2492,\"Codec\":\"h264\",\"Fps\":35,\"Lossrate\":0,\"Width\":540,\"Height\":960}",
"AudioInfo": "{\"Codec\":\"g711a\",\"SampleBit\":16,\"SampleRate\":8000}"
}
