你可以使用此接口查询指定单流转推任务的相关信息。
你可以调用GetPushSingleStreamToCDNTask
接口,指定你所属的 AppId
,查询指定 RoomId
下的单流任务。
你可以查询由客户端或服务端发起的单流转推任务,但返回的参数结构均为服务端的参数结构。
通过此接口仅能查询距今 72 小时内开始的单流转推任务。
在查询前,你必须已经在控制台上开通转推直播服务。
请求频率:QPS 不得超过 60。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetPushSingleStreamToCDNTask | 接口名称。当前 API 的名称为 GetPushSingleStreamToCDNTask 。 |
Version | String | 是 | 2023-06-01 | 接口版本。当前 API 的版本为 2023-06-01 。 |
AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
TaskId | String | 否 | Your_TaskId | 要查询的转推直播任务 ID。通过服务端发起时,该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时,TaskId 是按照 TaskId 和 UserId 均为非必填参数,但是你需要至少填一个参数以保证可以正常发起请求。 |
UserId | String | 否 | Your_UserId | 客户端发起转推任务的用户 ID。 你在客户端发起多个任务,当使用该接口进行查询时:
|
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PushSingleStreamToCDNTask | Object | - | 单流转推任务信息 |
StartTime | Long | 1677205841000 | 任务开始时间戳,Unix 时间,单位为毫秒 |
EndTime | Long | 1677205914000 | 任务结束时间戳,Unix 时间,单位为毫秒。 0 表示任务未结束 |
Status | Long | 3 | 任务状态。
|
StopReason | String | StopByAPI | 任务停止的原因
|
PushStreamState | Integer | 6 | 推流状态
Status =2 时,PushStreamState 有实际意义;当Status =3 时,PushStreamState =6 ; status 为其他值时,PushStreamState 均为0 。 |
Stream | Object | 房间内转推的流 | |
UserId | String | Your_UserId | 用户Id,表示这个流所属的用户。 |
StreamType | Integer | 0 | 流的类型,值可以取 0 或1 ,默认值为0 。0 表示普通音视频流,1 表示屏幕流。 |
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-06-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId&UserId=Your_UserId
{ "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": "Your_RequestId", "Action": "GetPushSingleStreamToCDNTask", "Version": "2023-06-01", "Service": "rtc", "Region": "cn-north-1" } }
您可访问公共错误码,获取更多错误码信息。