文档首页/ 视频接入服务 VIS/ API参考/ 视频流管理/ 更新视频流
更新时间：2024-07-03 GMT+08:00
查看PDF
分享

更新视频流

功能介绍

该接口用于更新视频流的详情，包括RTMP以及HTTP-FLV类型视频流。

接口约束

当视频流处于ACTIVE状态时，不允许修改视频接入类型

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/streams/{stream_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID

stream_name

是

String

视频流名称

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

普通租户的token。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。
表3 请求Body参数

参数

是否必选

参数类型

描述

access_type

否

String

视频接入类型，例如HTTP-FLV、RTMP等，不区分大小写。当视频流处于ACTIVE状态时，不允许修改该项。

encode_type

否

String

视频流编码格式，当前支持H264，不区分大小写。

access_key

否

String

RTMP视频流绑定的密钥Access Key。

url

否

String

HTTP-FLV视频流的拉流地址。URL必须是http或https协议的合法URL。格式要求：以“http://”或“https://”开头的字符串，例如“http://xxxx.xxx”。

description

否

String

视频流的描述信息。

share_type

否

String

视频流共享类型。

  • PRIVATE：非共享。
  • PUBLIC：共享。

不区分大小写。

tag

否

Array of StreamTag objects

和视频流关联的标签，一个视频流最多添加10个标签。

state

否

String

视频流状态,可选值如下。

  • ACTIVE：表示已激活。
  • STOPPED：表示已停用。
表4 StreamTag

参数

是否必选

参数类型

描述

key

否

String

标签的键。最大长度为36个UNICODE字符（一-鿿），可以包含大小写字母、数字、中划线（-）或者下划线（_），不能包含其他的特殊字符。

value

否

String

标签的值。最大长度为43个UNICODE字符（一-鿿），可以包含大小写字母、数字、点（.）、中划线（-）或者下划线（_），不能包含其他的特殊字符，也可以为空字符串。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

String

处理成功时返回

请求示例

PUT /v1/3266392d188c47d09948b1**********/streams/streamTest

{
  "state" : "ACTIVE"
}

响应示例

状态码： 200

正常

{
  "result" : "success"
}

状态码： 400

请求错误。具体返回错误码请参考错误码说明

{
  "error_msg" : "Invalid request parameter, url can not be null or empty when access type is HTTP-FLV.",
  "error_code" : "VIS.0005"
}

状态码

状态码

描述

200

正常

400

请求错误。具体返回错误码请参考错误码说明
父主题： 视频流管理

相关文档