• 沒有找到結果。

功能介绍

该接口用于创建视频流。包括RTMP以及HTTP-FLV类型视频流。

● 创建RTMP视频流时,用户可根据实际需求选择是否配置秘钥,如果配置了秘钥,

则进行RTMP推流时需要提供认证Token。如果不配置该参数,则推流时不需要进 行认证。

● 创建HTTP-FLV视频流时,需要HTTP-FLV视频流的拉流地址,且地址必须是http或 https协议的合法URL。

自定义流名称只能使用英文字母a~z,A-Z)、数字(0~9)以及连接符(-、_),连 接符(-、__)不能连续出现、不能单独注册,也不能放在开头和结尾。长度不低于 8,不超过128个字符。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/streams

5-1 路径参数

参数 是否必选 参数类型 描述

project_id 是 String 项目ID,获取方法请参考获取项 目ID

请求参数

5-2 请求 Header 参数

参数 是否必选 参数类型 描述

X-Auth-Token 是 String 普通租户的token。

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

X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请 求的发生时间。

X-Project-Id 否 String 使用AK/SK方式认证时必选,携 带项目ID信息。

5-3 请求 Body 参数

参数 是否必选 参数类型 描述

name 是 String 自定义流名称只能使用英文字母

a~z,A-Z)、数字(0~9)以及 连接符(-、_),连接符(-、

__)不能连续出现、不能单独注 册,也不能放在开头和结尾。长 度不低于 8,不超过128个字 符。

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

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

参数 是否必选 参数类型 描述

share_type 否 String 视频流共享类型。

● PRIVATE:非共享。

● PUBLIC:共享。

不填时默认为PRIVATE,不区分

url 否 String 当视频类型为RTMP协议时,不

需要该参数。当视频类型为

access_key 否 String 当视频类型为HTTP-FLV时,不 需要该参数。视频接入类型是

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

5-4 StreamTag

参数 是否必选 参数类型 描述

key 否 String 标签的键。最大长度为36个

UNICODE字符(一-鿿),可以 包含大小写字母、数字、中划线

(-)或者下划线(_),不能包 含其他的特殊字符。

value 否 String 标签的值。最大长度为43个

UNICODE字符(一-鿿),可以 包含大小写字母、数字、点

(.)、中划线(-)或者下划线

(_),不能包含其他的特殊字 符,也可以为空字符串。

响应参数

状态码: 201

5-5 响应 Body 参数

参数 参数类型 描述

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 String 视频流创建时间,UTC时间,格式为:YYYY-MM-DDTHH:MM:SSZ。

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

description String 视频流描述信息。

参数 参数类型 描述 tag Array of

StreamTag objects

和视频流关联的标签。

5-6 StreamTag

参数 参数类型 描述

key String

标签的键。最大长度为36个UNICODE字符(一-鿿),可以包含大小写字母、数字、中划线(-)

或者下划线(_),不能包含其他的特殊字符。

value String

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

请求示例

● RTMP

POST /v1/3266392d188c47d09948b1**********/streams { "name" : "stream_test1",

"access_type" : "RTMP", "encode_type" : "H264", "share_type" : "PUBLIC",

"access_key" : "ALKJOWLKJSDNFGO******KSJDF", "description" : "",

"tag" : [ { "key" : "group", "value" : "number1"

} ] }

● HTTP-FLV

POST /v1/3266392d188c47d09948b1**********/streams { "name" : "stream_test2",

"access_type" : "HTTP-FLV", "encode_type" : "H264", "share_type" : "PUBLIC",

"url" : "https://xxxxxxxx.com/live", "description" : "",

"tag" : [ {

● 示例 1

{ "stream_id" : "stream-0BOPSRsT", "name" : "stream_test1",

"encode_type" : "H264", "access_type" : "RTMP",

"access_key" : "ALKJOWLKJSDNFGO******KSJDF", "share_type" : "PUBLIC",

"state" : "STOPPED",

"created_at" : "2018-06-12T13:00:01Z", "updated_at" : "2018-06-12T13:00:01Z", "description" : "",

"tag" : [ {

{ "stream_id" : "stream-9IzU3TdL", "name" : "stream_test2", "encode_type" : "H264", "access_type" : "HTTP-FLV", "url" : "https://xxxxxxxx.com/live", "share_type" : "PUBLIC",

"state" : "STOPPED",

"created_at" : "2018-06-12T13:00:01Z", "updated_at" : "2018-06-12T13:00:01Z", "description" : "",

"tag" : [ {

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

}