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

文档中心

立即注册

导航

慢直播

编辑视频流

最近更新时间：2022.02.08 14:18:20首次发布时间：2021.11.25 17:21:46

更新指定视频流的信息。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	UpdateStream
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取
StreamID	Query	String	是	视频流 ID	可通过调用 ListStreams 接口获取

Body 参数

字段	类型	必填	说明
StreamName	String	否	更新的视频流名称
Description	String	否	更新的视频流描述

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	更新成功的视频流 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdateStream
&Version=2021-01-01
&SpaceID=a2d6ca94-334b-4f81-b89c-02d381xxxxxx
&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"
    }
}