UpdateStream - 更新视频流--慢直播-火山引擎

文档中心

立即注册

导航

UpdateStream - 更新视频流

最近更新时间：2025.06.06 15:40:27首次发布时间：2021.11.25 17:21:46

更新指定视频流的信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateStream	要执行的操作，取值：UpdateStream。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
StreamName	String	否	Stream002	更新的视频流名称
StreamID	String	是	3a890d3f-6db4-4663-a5a6-9abf0683627f	视频流 ID，可通过调用 ListStreams 接口获取
Description	String	否	Update stream description	更新的视频流描述
PullSource	String	否	http://pull_domain/pull_stream	拉流地址

返回参数

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

参数	类型	示例值	描述
ID	String	3a890d3f-6db4-4663-a5a6-9abf0683627f	更新成功的视频流 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"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	ErrorStreamUpdatePara	InvalidParameter.UpdateStream
500	InternalErrorStreamDB	InternalError.StreamDB
500	UpdateStreamStatus	InternalError.UpdateStreamStatus