编辑视频流--慢直播-火山引擎

文档中心

立即注册

导航

编辑视频流

最近更新时间：2025.02.14 16:55:51首次发布时间：2021.11.25 17:21:46

更新指定视频流的信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateStream`	接口名称。当前 API 的名称为 `UpdateStream`。
Version	String	是	`2021-01-01`	接口版本。当前 API 的版本为 `2021-01-01`。
StreamID	String	是	`3a890d3f-6db4-4663-a5a6-9abf0683627f`	视频流 ID，可通过调用 ListStreams 接口获取

Body

参数	类型	是否必选	示例值	描述
StreamName	String	否	`Stream002`	更新的视频流名称
Description	String	否	`Update stream description`	更新的视频流描述
PullSource	String	否		拉流地址

返回参数

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

参数	类型	示例值	描述
ID	String	`3a890d3f-6db4-4663-a5a6-9abf0683627f`	更新成功的视频流 ID

请求示例

POST https://open.volcengineapi.com?&StreamID=3a890d3f-6db4-4663-a5a6-9abf0683627f
{
    "StreamName": "Stream002",
    "Description": "Update stream description"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081600180102100291610C00007E",
        "Action": "UpdateStream",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "3a890d3f-6db4-4663-a5a6-9abf0683627f"
    }
}

错误码

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