1. 接口描述
接口请求域名: iotvideoindustry.tencentcloudapi.com 。
创建直播频道
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateLiveChannel。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LiveChannelName | 是 | String | 直播频道名称 示例值:直播频道001 |
LiveChannelType | 是 | Integer | 直播频道类型 1:固定直播;2:移动直播 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LiveChannelId | String | 直播频道ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:72f556500f0311ec806aacde48001122 |
PushStreamAddress | String | 直播频道推流地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:rtmp://10.4.56.32:31935/liveFixed/72f556500f0311ec806aacde480011 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建直播频道
输入示例
POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLiveChannel
<公共请求参数>
{
"LiveChannelType": 1,
"LiveChannelName": "直播001"
}
输出示例
{
"Response": {
"LiveChannelId": "72f556500f0311ec806aacde48001122",
"PushStreamAddress": "rtmp://10.4.56.32:31935/liveFixed/72f556500f0311ec806aacde48001122",
"RequestId": "1"
}
}
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签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBOperationError | DB操作错误。 |
InternalError.InternalServerException | 内部错误。 |
InternalError.InternalServerExceptionDB | DB操作错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.BalanceNotEnough | 账户余额不足,请检查。 |
InvalidParameterValue.DeviceId | 设备Id不合法。 |
InvalidParameterValue.DeviceInfoNotExist | 设备通道不在线,请检查通道配置。 |
InvalidParameterValue.DeviceOffline | 设备离线或未注册。 |
InvalidParameterValue.DeviceTypeNotSupport | 设备类型不支持。 |
InvalidParameterValue.DomainId | 国标域/设备不存在或未注册。 |
InvalidParameterValue.ExpireTime | 超时时间错误。 |
InvalidParameterValue.GroupDomainidExtraInformation | domainid分组不允许修改ExtraInformation。 |
InvalidParameterValue.GroupDomainidNotUpdate | 国标平台下级分组不允许修改。 |
InvalidParameterValue.GroupParmsError | 分组参数错误。 |
InvalidParameterValue.RecordNotExist | 回看流不存在。 |
InvalidParameterValue.RecordPlanBeyondLimit | 最多创建100个录制计划。 |
InvalidParameterValue.StreamId | 流Id不合法。 |
InvalidParameterValue.StreamInfoNotExist | 流不存在,请检查设备配置。 |
InvalidParameterValue.TemplateBeyondLimit | 最多创建100个时间模板。 |
InvalidParameterValue.TemplateSpecEmpty | 模板时间片段为空。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DeviceNotExist | 设备未创建或是已删除。 |
ResourceNotFound.DeviceSipPTZError | PTZ控制的资源处于离线状态。 |
ResourceNotFound.GroupNotExist | 未找到分组或分组已删除。 |
ResourceNotFound.PlanNotExist | 未找到录制计划或录制计划已删除。 |
ResourceNotFound.ResourceNotFound | 未找到时间模板或时间模板已删除。 |
ResourceNotFound.StatDataNotExist | 统计数据不存在。 |
ResourceNotFound.TemplateNotExist | 未找到时间模板或时间模板已删除。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.GroupExist | 该名字分组已创建,请修改其他分组名字。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.BindExist | 分组下还存在设备或子分组。 |
UnsupportedOperation.DeviceBindExist | 绑定的设备列表中有已绑定录制计划的设备。 |
UnsupportedOperation.DeviceCanNotDo | 设备没有操作权限。 |
UnsupportedOperation.DeviceDupKeyExist | 存在重复设备。 |
UnsupportedOperation.DeviceMissMatch | 设备和通道不匹配,请检查。 |
UnsupportedOperation.DeviceNotFound | 绑定的设备列表中有不存在的设备。 |
UnsupportedOperation.DeviceSipCommandFail | 设备信令不通。 |
UnsupportedOperation.DomainGroup | 该分组为平台下级分组,不允许删除。 |
UnsupportedOperation.GroupExist | 该名字分组已创建,请修改其他分组名字。 |
UnsupportedOperation.GroupLayerIsMax | 分组层级超过最大值。 |
UnsupportedOperation.GroupParentidNotExist | 父分组不存在。 |
UnsupportedOperation.PlanExistUnderTemplate | 时间模板下存在未删除的录制计划时不允许删除或修改。 |
UnsupportedOperation.RecordPlanExist | 该名字录制计划已创建,请修改其他计划名字。 |
UnsupportedOperation.SubGroupIsMax | 子分组数量超过最大值。 |
UnsupportedOperation.SubgrpExist | 分组下还存在设备或子分组。 |
UnsupportedOperation.TemplateExist | 该名字时间模板已创建,请修改其他模板名字。 |
UnsupportedOperation.TemplatePreset | 预置时间模板不允许删除或修改。 |
UnsupportedOperation.UserIsIsolate | 处于隔离中的资源不能进行此操作。 |