1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
请求设备直播流地址
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeStream。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Tid | 否 | String | 设备TID 示例值:xxxxxxxx |
AccessId | 否 | String | 终端用户ID 示例值:xxxxx |
Protocol | 否 | String | 直播协议, 可选值:RTSP、RTMP、HLS、HLS-fmp4 示例值:RTMP |
Address | 否 | String | 音视频流地址 示例值:xxxxx |
AccessToken | 否 | String | 设备访问token,访问用户未绑定的设备时,需提供该参数 示例值:xxxxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Data | 返回参数结构 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取音视频流地址
输入示例
https://iotvideo.tencentcloudapi.com/?Action=DescribeStream
&Tid=******
&AccessId=******
&Protocol=******
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "43348837-xxxx-xxxx-xxxx-77c333c1b96e",
"Data": {
"Protocol": "RTSP",
"URI": "xxxxxxxxxxxxxxx",
"ExpireTime": 1602589211,
"VideoCodec": "H265",
"AudioCodec": "G711"
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.SignatureFailure | 签名校验失败。 |
AuthFailure.TokenFailure | 获取token为空。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.DeviceFirmwareTaskAlreadDone | 设备固件升级任务已经完成。 |
FailedOperation.DeviceIsUpdating | 设备正在升级中。 |
FailedOperation.DeviceRunningOtherOtaTask | 设备已经运行其他ota升级任务。 |
FailedOperation.PermissionDenied | 无相关操作权限。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.FirmwareAlreadyExist | 固件已存在。 |
InvalidParameterValue.Tid | tid非法。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DeviceFirmwareTaskNotExist | 设备固件升级任务不存在。 |
ResourceNotFound.DeviceHasNoFirmware | 设备无固件版本。 |
ResourceNotFound.FirmwareNotExist | 固件不存在。 |
ResourceNotFound.FirmwareTaskNotExist | 固件升级任务不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |