查询输入在线媒体流

最近更新时间:2024-03-12 10:45:11

我的收藏

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

您可以查询输入在线媒体流任务的状态。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStreamIngest。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
SdkAppId Integer TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同
示例值:1234
TaskId String 任务的唯一Id,在启动任务成功后会返回。
示例值:1234

3. 输出参数

参数名称 类型 描述
Status String 任务的状态信息。
InProgress:表示当前任务正在进行中。
NotExist:表示当前任务不存在。
示例值:InProgress
示例值:InProgress
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务

查询SdkAppId为1234567890下的TaskId为1234的任务状态

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamIngest
<公共请求参数>

{
    "SdkAppId": 1234567890,
    "TaskId": "1234"
}

输出示例

{
    "Response": {
        "Status": "InProgress",
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.QueryTaskInfoFailed 查询任务失败
InternalError.DBError 数据库查询异常。
InvalidParameter.TaskId TaskId 参数错误。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.TaskId 缺少TaskId参数。