云服务器内容精选

  • 响应示例 状态码: 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" }
  • 请求参数 表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 表3 响应Body参数 参数 参数类型 描述 access_type String 视频接入类型(例如HTTP-FLV、RTMP、GB/T28181)。 updated_at String 视频流更新时间。 share_type String 视频流共享类型。 PRIVATE:非共享。 PUBLIC:共享。 stream_id String 视频流ID。 access_key String RTMP视频流的密钥。接入类型(access_type)为RTMP时,才有该参数。 url String HTTP-FLV视频流的地址。接入类型(access_type)为HTTP-FLV时,才有该参数。 transfer_protocol String GB视频传输协议(TCP|UDP)。只有当视频接入类型为GB/T28181时,才有该参数。 name String 视频流名称。 created_at String 视频流创建时间。 description String 视频流描述信息。 state String 视频流状态。 ACTIVE:表示已激活。 STOPPED:表示已停用。 默认为STOPPED。 tag Array of StreamTag objects 和视频流关联的标签。 retention retention object 视频转储信息。 stream_flow_info Stream_Flow_Info object 视频流详细信息。 encode_type String 视频流编码格式。 retention_state String 按视频流转储状态过滤,可选值如下。 ACTIVE:表示已启用转储。 STOPPED:表示未启用转储。 不区分大小写。 表4 StreamTag 参数 参数类型 描述 key String 标签的键。最大长度为36个UNICODE字符(一-鿿),可以包含大小写字母、数字、中划线(-)或者下划线(_),不能包含其他的特殊字符。 value String 标签的值。最大长度为43个UNICODE字符(一-鿿),可以包含大小写字母、数字、点(.)、中划线(-)或者下划线(_),不能包含其他的特殊字符,也可以为空字符串。 表5 retention 参数 参数类型 描述 retention_in_hour Integer 保存时长,以小时为单位。 Retention_forever Boolean 是否永久保存。 store_type String 转储位置,可为“obs”,即存储到华为云 对象存储OBS 上。 bucket String OBS桶名。 path String OBS目录。 timezone String 时区信息。 slice_in_minute Integer 分片长度,以分钟为单位。取值范围为1~60,默认为5。 表6 Stream_Flow_Info 参数 参数类型 描述 is_publishing Boolean 视频流是否在推流/拉流。 RTMP类型: 表示是否正在推流。 HTTP-FLV类型: 表示是否正在从URL中拉取视频数据。 bw_out String 出流带宽。 正在推流(即is_publishing为true)时会返回该字段。 注:暂时无法提供该数据,数据内容无意义。 bw_in String 推流码率。正在推流(即is_publishing为true)时会返回该字段。 bw_video String 视频带宽。正在推流(即is_publishing为true)时会返回该字段。 注:暂时无法提供该数据,数据内容无意义。 bw_audio String 音频带宽。正在推流(即is_publishing为true)时会返回该字段。 注:暂时无法提供该数据,数据内容无意义。 bytes_out String 出流总量。 注:暂时无法提供该数据,数据内容无意义。 bytes_in String 入流总量。 注:暂时无法提供该数据,数据内容无意义。 num_play_clients String 正在拉取该视频流数据的客户端数量。正在推流(即is_publishing为true)时会返回该字段。 meta Video object 实时推流视频流元数据。正在推流(即is_publishing为true)时会返回该字段。 表7 Video 参数 参数类型 描述 video VideoInfo object 推流视频流视频相关数据。 表8 VideoInfo 参数 参数类型 描述 codec String 视频编码格式。 width String 视频分辨率水平方向像素。 height String 视频分辨率垂直方向像素。
  • 响应示例 状态码: 200 正常 { "access_type" : "RTMP", "updated_at" : "2018-12-25T12:59:37Z", "share_type" : "PUBLIC", "stream_id" : "stream-0P5g9fQ2", "access_key" : "ALKJOWLKJSDNFGO******KSJDF", "name" : "stream_test1", "description" : "", "state" : "ACTIVE", "tag" : [ { "key" : "group", "value" : "number1" } ], "retention" : { "bucket" : "iva-ly-test", "path" : "testRetention/", "timezone" : "GMT+08:00", "retention_in_hour" : 1, "retention_forever" : false, "store_type" : "OBS", "slice_in_minute" : 5, "state" : "ACTIVE" }, "stream_flow_info" : { "bw_out" : "100 Kb/s", "bw_in" : "100 Kb/s", "bytes_out" : "131.469 MB", "bw_video" : "100 Kb/s", "bytes_in" : "110.28 MB", "num_play_clients" : 2, "bw_audio" : "100 Kb/s", "is_publishing" : true, "meta" : { "video" : { "codec" : "H264", "width" : 400, "height" : 600 } } }, "encode_type" : "H264"} 状态码: 400 请求错误。具体返回错误码请参考错误码说明 { "error_msg" : "The entered stream ID does not exist.", "error_code" : "VIS.0202"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。