查询回放流状态V3--慢直播-火山引擎

文档中心

立即注册

导航

查询回放流状态V3

最近更新时间：2025.02.14 16:31:52首次发布时间：2025.02.14 16:31:52

查询回放流状态。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetPlaybackStatus&Version=2023-10-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetPlaybackStatus`	接口名称。当前 API 的名称为 `GetPlaybackStatus`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。
PlaybackID	String	是	`524c804d-0149-4b58-8209-2f17f6xxxxxx`	回放流 ID，可通过 StartPlayback 接口获取

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述

参数	类型	示例值	描述
Status	String	`pulling`	回放流状态： pulling（拉流中） online（在线） offline（离线） failed（失败） deleted（不存在、已释放）

Status

String

pulling

回放流状态：

pulling（拉流中）
online（在线）
offline（离线）
failed（失败）
deleted（不存在、已释放）

请求示例

GET https://open.volcengineapi.com?Action=GetPlaybackStatus&Version=2023-10-01&PlaybackID=524c804d-0149-4b58-8209-2f17f6xxxxxx

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetPlaybackStatus",
    "Version": "2023-10-01",
    "Service": "aiotvideo",
    "Region": "cn-north-1"
  },
  "Result": {
    "Status": "pulling"
  }
}

错误码

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