You need to enable JavaScript to run this app.
导航

回放流状态

最近更新时间2023.07.13 14:35:39

首次发布时间2023.07.12 17:32:32

查询回放流状态。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称PlayBackStat
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
StreamIDQueryString视频流 ID可通过 PlayBackStart 接口获取

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明

Status

String

回放流状态:

  • pulling(拉流中)

  • online(在线)

  • offline(离线)

  • failed(失败)

  • deleted(不存在、已释放)

示例

请求示例

GET https://open.volcengineapi.com?Action=PlayBackStat
&Version=2021-01-01
&StreamID=524c804d-0149-4b58-8209-2f17f6xxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202208101633120102250990080808695F",
        "Action": "PlayBackStat",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    }
    "Result": {
        "Status": "pulling"
    }
}