1. 接口描述
接口请求域名： weilingwith.tencentcloudapi.com 。
断流接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：StopVideoStreaming。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-27。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Stream | 是 | String | 流的唯一标识，播放链接尾缀 示例值：c0e3f641-6ec6-444e-8ac9-3cfecc755cb0 |
| WID | 是 | String | 设备的唯一标识 示例值：c0e3f641-6ec6-444e-8ac9-3cfecc755cb0 |
| WorkspaceId | 是 | Integer | 工作空间Id 示例值：1016 |
| ApplicationToken | 是 | String | 应用token 示例值：xxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | EmptyRes | 停流接口返回结果 示例值：{"Msg":"ok"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 断流接口
成功响应
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopVideoStreaming
<公共请求参数>
{
"Stream": "63ca1c08-81b7-499c-a95e-70e6abed4118",
"WID": "63ca1c08-81b7-499c-a95e-70e6abed4118",
"WorkspaceId": 1016,
"ApplicationToken": "RewYT6DXVWDg51Sx8tdcj89cX1pEns2h"
}输出示例
{
"Response": {
"RequestId": "abb1962d-cc04-4113-9302-95a21f6ba18d",
"Result": {
"Msg": "ok"
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter.EmptyStream | stream参数缺失 |
| MissingParameter.EmptyWID | WID参数缺失 |
| ResourceNotFound.CameraBaseInfoNotExist | 摄像头基础信息不存在 |
| ResourceNotFound.CameraStatusNotExist | 摄像头状态不存在 |
| ResourceUnavailable.DeviceOffline | 设备已离线 |
| UnsupportedOperation.NotStreaming | 未推流 |