{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"GetStreamInfoResponseBody":{"properties":{"access_key":{"description":"RTMP视频流的密钥。接入类型(access_type)为RTMP时,才有该参数。","example":"ALKJOWLKJSDNFGO******KSJDF","type":"string"},"access_type":{"description":"视频接入类型(例如HTTP-FLV、RTMP、GB/T28181)。","example":"RTMP","type":"string"},"created_at":{"description":"视频流创建时间。","example":"2019-01-28T07:57:21Z","type":"string"},"description":{"description":"视频流描述信息。","example":"","type":"string"},"encode_type":{"description":"视频流编码格式。","example":"H264","type":"string"},"name":{"description":"视频流名称。","example":"channel_9812399046132*****","type":"string"},"retention":{"$ref":"#/definitions/retention","description":"视频转储信息。"},"retention_state":{"description":"按视频流转储状态过滤,可选值如下。\n- ACTIVE:表示已启用转储。\n- STOPPED:表示未启用转储。\n\n不区分大小写。","example":"STOPPED","type":"string"},"share_type":{"description":"视频流共享类型。\n- PRIVATE:非共享。\n- PUBLIC:共享。","example":"PUBLIC","type":"string"},"state":{"description":"视频流状态。\n- ACTIVE:表示已激活。\n- STOPPED:表示已停用。\n\n默认为STOPPED。","example":"STOPPED","type":"string"},"stream_flow_info":{"$ref":"#/definitions/Stream_Flow_Info","description":"视频流详细信息。"},"stream_id":{"description":"视频流ID。","example":"stream-0P5g9fQ2","type":"string"},"tag":{"description":"和视频流关联的标签。","items":{"$ref":"#/definitions/StreamTag"},"type":"array"},"transfer_protocol":{"description":"GB视频传输协议(TCP|UDP)。只有当视频接入类型为GB/T28181时,才有该参数。","example":"TCP","type":"string"},"updated_at":{"description":"视频流更新时间。","example":"2018-12-25T12:59:37Z","type":"string"},"url":{"description":"HTTP-FLV视频流的地址。接入类型(access_type)为HTTP-FLV时,才有该参数。","example":"https://xxxxxxxx.com/live","type":"string"}}},"StreamTag":{"properties":{"key":{"description":"标签的键。最大长度为36个UNICODE字符(一-鿿),可以包含大小写字母、数字、中划线(-)或者下划线(_),不能包含其他的特殊字符。","example":"group","type":"string"},"value":{"description":"标签的值。最大长度为43个UNICODE字符(一-鿿),可以包含大小写字母、数字、点(.)、中划线(-)或者下划线(_),不能包含其他的特殊字符,也可以为空字符串。","example":"number1","type":"string"}}},"Stream_Flow_Info":{"properties":{"bw_audio":{"description":"音频带宽。正在推流(即is_publishing为true)时会返回该字段。\n\n注:暂时无法提供该数据,数据内容无意义。","example":"0 Kb/s","type":"string"},"bw_in":{"description":"推流码率。正在推流(即is_publishing为true)时会返回该字段。","example":"102.883 Kb/s","type":"string"},"bw_out":{"description":"出流带宽。 正在推流(即is_publishing为true)时会返回该字段。\n\n注:暂时无法提供该数据,数据内容无意义。","example":"0 Kb/s","type":"string"},"bw_video":{"description":"视频带宽。正在推流(即is_publishing为true)时会返回该字段。\n\n注:暂时无法提供该数据,数据内容无意义。","example":"102.883 Kb/s","type":"string"},"bytes_in":{"description":"入流总量。\n\n注:暂时无法提供该数据,数据内容无意义。","example":"17.412 GB","type":"string"},"bytes_out":{"description":"出流总量。\n\n注:暂时无法提供该数据,数据内容无意义。","example":"15.775 GB","type":"string"},"is_publishing":{"description":"视频流是否在推流/拉流。\n- RTMP类型: 表示是否正在推流。\n- HTTP-FLV类型: 表示是否正在从URL中拉取视频数据。","example":true,"type":"boolean"},"meta":{"$ref":"#/definitions/Video","description":"实时推流视频流元数据。正在推流(即is_publishing为true)时会返回该字段。"},"num_play_clients":{"description":"正在拉取该视频流数据的客户端数量。正在推流(即is_publishing为true)时会返回该字段。","example":"0","type":"string"}}},"Video":{"properties":{"video":{"$ref":"#/definitions/VideoInfo","description":"推流视频流视频相关数据。"}}},"VideoInfo":{"properties":{"codec":{"description":"视频编码格式。","example":"H264","type":"string"},"height":{"description":"视频分辨率垂直方向像素。","example":"600","type":"string"},"width":{"description":"视频分辨率水平方向像素。","example":"400","type":"string"}}},"retention":{"properties":{"Retention_forever":{"description":"是否永久保存。","example":"false","type":"boolean"},"bucket":{"description":"OBS桶名。","example":"iva-ly-test","type":"string"},"path":{"description":"OBS目录。","example":"testRetention/***","type":"string"},"retention_in_hour":{"description":"保存时长,以小时为单位。","example":1,"type":"integer"},"slice_in_minute":{"description":"分片长度,以分钟为单位。取值范围为1~60,默认为5。","example":5,"type":"integer"},"store_type":{"description":"转储位置,可为“obs”,即存储到华为云对象存储OBS上。","example":"obs","type":"string"},"timezone":{"description":"时区信息。","example":"GMT+08:00","type":"string"}}}},"description":null,"group_id":"5346b7c1dc284228a28795d5bcbd550d","host":"vis.cn-north-4.myhuaweicloud.com","id":"86115019f46346589800ad2f4a873b22","info_version":"v1","method":"get","name":"ListStreamInfos","parameters":{"Authorization":{"description":"使用AK/SK方式认证时必选,携带的鉴权信息。","in":"header","maxLength":256,"minLength":1,"name":"Authorization","required":false,"type":"string","x-example":"SDK-HMAC-SHA256 Access=xxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxx"},"X-Auth-Token":{"description":"普通租户的token。","in":"header","maxLength":10240,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string"},"X-Project-Id":{"description":"使用AK/SK方式认证时必选,携带项目ID信息。","in":"header","maxLength":64,"minLength":1,"name":"X-Project-Id","required":false,"type":"string","x-example":"70b76xxxxxx34253880af501cdxxxxxx"},"X-Sdk-Date":{"description":"使用AK/SK方式认证时必选,请求的发生时间。","in":"header","maxLength":256,"minLength":1,"name":"X-Sdk-Date","required":false,"type":"string","x-example":"20191115T033655Z"},"project_id":{"description":"项目ID,获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-vis/vis_03_0005.html)","in":"path","maxLength":32,"minLength":32,"name":"project_id","required":true,"type":"string"}},"paths":{"/v1/{project_id}/streams/{stream_name}":{"get":{"consumes":[],"deprecated":false,"description":"此接口用于获取指定视频流的详细信息。\n\n说明:Stream_Flow_Info中部分字段数据暂时无法提供,数据内容无意义。","operationId":"ListStreamInfos","parameters":[{"$ref":"#/parameters/project_id"},{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/X-Sdk-Date"},{"$ref":"#/parameters/X-Project-Id"},{"description":"视频流名称","in":"path","name":"stream_name","required":true,"type":"string","x-example":"stream****"}],"produces":[],"responses":{"200":{"description":"正常","examples":{"application/json":{"access_key":"ALKJOWLKJSDNFGO******KSJDF","access_type":"RTMP","description":"","encode_type":"H264","name":"stream_test1","retention":{"bucket":"iva-ly-test","path":"testRetention/","retention_forever":false,"retention_in_hour":1,"slice_in_minute":5,"state":"ACTIVE","store_type":"OBS","timezone":"GMT+08:00"},"share_type":"PUBLIC","state":"ACTIVE","stream_flow_info":{"bw_audio":"100 Kb/s","bw_in":"100 Kb/s","bw_out":"100 Kb/s","bw_video":"100 Kb/s","bytes_in":"110.28 MB","bytes_out":"131.469 MB","is_publishing":true,"meta":{"video":{"codec":"H264","height":600,"width":400}},"num_play_clients":2},"stream_id":"stream-0P5g9fQ2","tag":[{"key":"group","value":"number1"}],"updated_at":"2018-12-25T12:59:37Z"}},"schema":{"$ref":"#/definitions/GetStreamInfoResponseBody"}},"400":{"description":"请求错误","examples":{"application/json":{"error_code":"VIS.0202","error_msg":"The entered stream ID does not exist."}}}},"summary":"获取视频流信息","tags":["视频流管理"],"x-apiexplorer-hide":"N","x-is-registered":"Y","x-name":"获取视频流信息","x-request-examples-url-1":"GET /v1/3266392d188c47d09948b1**********/streams/stream1","x-support-sdk":"Y"}}},"product_short":"VIS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取视频流信息","tags":"视频流管理","uri":null,"version":"2.0"}