文档首页 > > API参考> API> 视频流管理> 创建视频流

创建视频流

分享
更新时间: 2019/09/03 16:30

功能介绍

该接口用于创建视频流。

URI

  • URI格式
    POST /v1/{project_id}/streams
  • 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目ID,获取方法请参见获取项目ID

请求

  • 请求样例1(RTMP)
    POST /v1/3266392d188c47d09948b1859f0a5e07/streams
    {
         "name": "stream1",
         "access_type": "RTMP",
         "encode_type": "H264",
         "share_type": "PUBLIC",
         "access_key": "ALKJOWLKJSDNFGxxxxxELKSJDF",
         "description": "",
         "tag": [
             {
                  "key": "group",
                  "value": "number1"
             }
         ]
    }
  • 请求样例2(HTTP-FLV)
    POST /v1/3266392d188c47d09948b1859f0a5e07/streams
    {
        "name": "stream2",
        "access_type": "HTTP-FLV",
        "encode_type": "H264",
        "share_type": "PUBLIC",
        "url": " https://xxxxxxxx.com/live",
        "description": "",
        "tag": [
             {
                  "key": "group",
                  "value": "number1"
             }
        ]
    }
  • 参数说明

    参数

    是否必选

    类型

    说明

    name

    String

    视频流的名称,所有用户之间的视频流名称不能重名。

    长度为1~32,可以包含字母、数字、中划线(-)或者下划线(_),不能包含其他的特殊字符。

    access_type

    String

    视频接入类型,当前支持HTTP-FLV和RTMP,不区分大小写。

    encode_type

    String

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

    share_type

    String

    视频流共享类型:
    • PRIVATE:非共享。
    • PUBLIC:共享。

    不填时默认为PRIVATE,不区分大小写。

    当值为PRIVATE,用户在拉取视频时会鉴权,拉流时必须在请求头中添加X-Auth-Token,值为创建视频流的用户的Token。

    拉流地址参考获取视频流地址

    url

    String

    • 当视频类型为RTMP时,不需要该参数。
    • 当视频类型为HTTP-FLV时,该参数必填,表示HTTP-FLV视频流的拉流地址。

      该地址必须是http或https协议的合法URL,格式要求以“http://”“https://”开头的字符串,例如“http://xxxx.xxx”

    access_key

    String

    • 当视频类型为HTTP-FLV时,不需要该参数。
    • 视频接入类型是RTMP时,该参数表示秘钥access_key,用户可根据自己实际需求选择是否配置:
      • 如果配置了秘钥access_key,则进行RTMP推流时需要提供认证Token。这里的秘钥access_key由创建AK/SK凭证接口生成,参见接口响应参数access_key中的值。

        配置了秘钥access_key后,在推流时,需要在原始推流地址后面加上若干查询参数,作为推流认证信息,具体请参见推流鉴权规则

      • 如果不配置该参数,表示不提供access_key,则推流时不需要进行认证。

    description

    String

    视频流的描述信息,可填字符串最大长度为500。

    tag

    Array

    和视频流关联的标签,参见Tag参数结构说明

    一个视频流最多添加10个标签。

  • Tag参数结构说明

    参数

    类型

    说明

    key

    String

    标签的键。最大长度为36个UNICODE字符(\u4E00-\u9FFF),可以包含大小写字母、数字、中划线(-)或者下划线(_),不能包含其他的特殊字符。

    value

    String

    标签的值。最大长度为43个UNICODE字符(\u4E00-\u9FFF),可以包含大小写字母、数字、点(.)、中划线(-)或者下划线(_),不能包含其他的特殊字符,也可以为空字符串。

响应

  • 响应样例1(接入类型为RTMP)
    {
        "stream_id": "streamtngw6xsj",
        "name": "stream1",
        "encode_type": "H264",
        "access_type": "RTMP",
        "access_key": "ALKJOWLKJSDNFGOxxxxxLKSJDF",
        "share_type": "PRIVATE",
        "state": "STOPPED",
        "created_at": "2018-06-12T13:00:01Z",
        "updated_at": "2018-06-12T13:00:01Z",
        "description": "",
        "tag": [
             {
                  "key": "group",
                  "value": "group#1"
             }
           ]
    }
  • 响应样例2(接入类型为HTTP-FLV)
    {
        "stream_id": "streamtngw6xsf",
        "name": "stream2",
        "encode_type": "H264",
        "access_type": "HTTP-FLV",
        "url": " https://xxxxxxxx.com/live",
        "share_type": "PRIVATE",
        "state": "STOPPED",
        "created_at": "2018-06-12T13:00:01Z",
        "updated_at": "2018-06-12T13:00:01Z",
        "description": "",
        "tag": [
                 {
                  "key": "group",
                  "value": "number1"
                 }
        ]
    }
  • 参数说明

    参数

    类型

    说明

    stream_id

    String

    视频流ID。

    name

    String

    视频流的名称。

    encode_type

    String

    视频流编码格式。

    access_type

    String

    视频接入类型。

    access_key

    String

    RTMP视频流的密钥。接入类型(access_type)为RTMP时,才有该参数。

    url

    String

    HTTP-FLV视频流的拉流地址。接入类型(access_type)为HTTP-FLV时,才有该参数。

    share_type

    String

    视频流共享类型。

    state

    String

    视频流状态:
    • ACTIVE:表示已激活。
    • STOPPED:表示已停用。

    默认为STOPPED。

    created_at

    Long

    视频流创建时间,UTC时间,格式为:YYYY-MM-DDTHH:MM:SSZ。

    updated_at

    Long

    视频流更新时间,UTC时间,格式为:YYYY-MM-DDTHH:MM:SSZ。

    description

    String

    视频流描述信息。

    tag

    Array

    和视频流关联的标签。

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

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

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源或没有开通服务。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区