你可以使用此接口查询指定单流转推任务的相关信息。

接口行为

你可以调用GetPushSingleStreamToCDNTask接口，指定你所属的 AppId，查询指定 RoomId 下的单流任务。

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

通过此接口仅能查询距今 72 小时内开始的单流转推任务。

前置条件

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 60。

请求方式

使用 Get 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`GetPushSingleStreamToCDNTask`	接口名称，本接口取值：`GetPushSingleStreamToCDNTask`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
TaskId	String	否	`Your_TaskId`	要查询的转推任务 ID。关于 TaskId 和 UserId，请参看注释1。
UserId	String	否	`Your_UserId`	客户端发起转推任务的用户 ID。关于 UserId，详情请参看注释2。

注释1:

TaskId 和 UserId 均为非必填参数，但是你需要至少填一个参数以保证可以正常发起请求。

注释2:

你在客户端发起多个任务，当使用该接口进行查询时：

查询第一个任务时，UserId 可以传入发起转推任务的用户 UserId，TaskId 传入空字符串；或直接将该用户的 UserId 传入 TaskId。
查询第二个以上任务时，UserId 和 TaskId 为发起转推任务的用户 UserId 和 TaskId。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=GetPushSingleStreamToCDNTask&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId&UserId=Your_UserId

返回调用结果

返回结果参看 BaseResponse。
其中 Result 的结构如下：

参数名	类型	描述
PushSingleStreamToCDNTask	PushSingleStreamToCDNTask	单流转推任务信息

PushSingleStreamToCDNTask

参数名	类型	描述
StartTime	Uint64	任务开始时间戳，Unix 时间，单位为毫秒
EndTime	Uint64	任务结束时间戳，Unix 时间，单位为毫秒。`0` 表示任务未结束
Status	Uint64	任务状态。 `0`: 未知异常状态 `1`: 未开始 `2`: 运行中 `3`: 已结束 `4`: 任务运行失败
StopReason	String	任务停止的原因 `无`：表示任务未结束 `UnknownStopReason`：未知停止原因 `StopByAPI`：用户主动调用服务端 OpenAPI 停止 `StartTaskFailed`：任务启动失败 `IdleTimeOut`：任务超过最大空闲时间 `UserDisconnect`：客户端用户主动退房/调用停止转推接口
Stream	Stream	房间内转推的流
PushURL	String	推流地址。目前仅支持 rtmp 协议
Control	Control	配置选项

正常返回示例

{
    "Result": {
        "PushSingleStreamToCDNTask": {
            "StartTime": 1677205841000,
            "EndTime": 1677205914000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "PushURL": "rtmp://xxxxx",
            "Stream": {
                "Index": 0,
                "UserId": "user1",
                "StreamType": 1
            },
            "Control": {
                "MediaType": 1,
                "MaxIdleTime": 180
            }
        }
    },
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetPushSingleStreamToCDNTask",
        "Version": "2020-12-01"
    }
}
json