查询单流转推任务状态 GetPushSingleStreamToCDNTask--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

查询单流转推任务状态 GetPushSingleStreamToCDNTask

最近更新时间：2024.07.16 15:31:21首次发布时间：2024.01.03 20:25:16

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需查询单流转推至 CDN 的任务详情，你可通过调用此接口实现。

通过指定应用标识和房间 ID，你可获取任务的开始与结束时间、当前状态、停止原因、推流状态、流信息、推流地址及配置选项等详细信息。此接口适用于查询 72 小时内启动的单流转推任务。

使用说明

接口行为

你可以查询由客户端或服务端发起的单流转推任务，但返回的参数结构均为服务端的参数结构。

前置条件

在查询前，你必须已经在控制台上开通转推直播服务。

注意事项

请求频率：QPS 不得超过 60。

请求说明

请求方式：GET
请求地址：https://rtc.volcengineapi.com?Action=GetPushSingleStreamToCDNTask&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetPushSingleStreamToCDNTask`	接口名称。当前 API 的名称为 `GetPushSingleStreamToCDNTask`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
TaskId	String	否	`Your_TaskId`	要查询的转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时，TaskId 是按照 `userId`@@`taskId` 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 `userId`。 `TaskId` 和 `UserId` 均为非必填参数，但是你需要至少填一个参数以保证可以正常发起请求。
UserId	String	否	`Your_UserId`	客户端发起转推任务的用户 ID。你在客户端发起多个任务，当使用该接口进行查询时：查询第一个任务时，`UserId` 可以传入发起转推任务的用户 `UserId`，`TaskId` 传入空字符串；或直接将该用户的 `UserId` 传入 `TaskId`。查询第二个以上任务时，`UserId` 和 `TaskId` 为发起转推任务的用户 `UserId` 和 `TaskId`。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
PushSingleStreamToCDNTask	Object	`-`	单流转推任务信息
StartTime	Long	`1677205841000`	任务开始时间戳，Unix 时间，单位为毫秒
EndTime	Long	`1677205914000`	任务结束时间戳，Unix 时间，单位为毫秒。`0` 表示任务未结束
Status	Long	`3`	任务状态。 `0`: 未知异常状态 `1`: 未开始 `2`: 运行中 `3`: 已结束 `4`: 任务运行失败
StopReason	String	`StopByAPI`	任务停止的原因返回为空：表示任务未结束 `UnknownStopReason`：未知停止原因 `StopByAPI`：用户主动调用服务端 OpenAPI 停止 `StartTaskFailed`：任务启动失败 `IdleTimeOut`：任务超过最大空闲时间 `UserDisconnect`：客户端用户主动退房/调用停止转推接口
PushStreamState	Integer	`6`	推流状态 `0`：未获取到任务状态。建议稍后重新查询 `1`：未开始推流 `2`：首次连接 CDN 服务 `3`：正在重连 CDN 服务 `4`：连接 CDN 服务成功，正在尝试推流。 `5`：连接 CDN 服务成功，推流成功 `6`：已停止推流。仅当`Status`=`2` 时，`PushStreamState` 有实际意义；当`Status`=`3` 时，`PushStreamState`=`6`; `status` 为其他值时，`PushStreamState` 均为`0`。
Stream	Object	`-`	房间内转推的流
UserId	String	`user1`	用户Id，表示这个流所属的用户。
StreamType	Integer	`0`	流的类型。支持取值及含义如下： `0`：普通音视频流， `1`：屏幕流。默认值为`0`。
PushURL	String	`rtmp://xxxxx`	推流地址。目前仅支持 rtmp 协议
Control	Object		配置选项
MediaType	Integer	`0`	流的类型，用于全局控制订阅的流的类型。默认值为 `0`，可以取`0`和`1`。`0`表示音视频，`1`表示纯音频，暂不支持纯视频。
MaxIdleTime	Integer	`180`	任务的空闲超时时间，超过此时间后，任务自动终止。取值范围为 `[10, 86400]`, 单位为秒，默认值为 `180`。

请求示例

GET https://rtc.volcengineapi.com?Action=GetPushSingleStreamToCDNTask&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1&TaskId=Task1&UserId=user1

返回示例

{
    "Result": {
        "PushSingleStreamToCDNTask": {
            "StartTime": 1677205841000,
            "EndTime": 1677205914000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "PushStreamState": "6",
            "PushURL": "rtmp://xxxxx",
            "Stream": {
                "Index": 0,
                "UserId": "user1",
                "StreamType": 1
            },
            "Control": {
                "MediaType": 1,
                "MaxIdleTime": 180
            }
        }
    },
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "GetPushSingleStreamToCDNTask",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。