huawei-cloud-api-definitions-VIS 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"StreamTag":{"properties":{"key":{"description":"标签的键。最大长度为36个UNICODE字符(一-鿿),可以包含大小写字母、数字、中划线(-)或者下划线(_),不能包含其他的特殊字符。","example":"group","type":"string"},"value":{"description":"标签的值。最大长度为43个UNICODE字符(一-鿿),可以包含大小写字母、数字、点(.)、中划线(-)或者下划线(_),不能包含其他的特殊字符,也可以为空字符串。","example":"number1","type":"string"}}},"UpdateResponse":{"properties":{"result":{"description":"处理成功时返回","example":"success","type":"string"}}},"UpdateStreamRequestList":{"properties":{"access_key":{"description":"RTMP视频流绑定的秘钥Access Key。","example":"ALKJOWLKJSDNFGO******KSJDF","type":"string"},"access_type":{"description":"视频接入类型,例如HTTP-FLV、RTMP等,不区分大小写。当视频流处于ACTIVE状态时,不允许修改该项。","enum":["HTTP-FLV","RTMP","RTP"],"example":"RTMP","maxLength":32,"minLength":1,"pattern":"^[A-Za-z0-9\\-_]*","type":"string"},"description":{"description":"视频流的描述信息。","example":"","maxLength":500,"type":"string"},"encode_type":{"description":"视频流编码格式,当前支持H264,不区分大小写。","enum":["H264","H265","NONE"],"example":"H264","type":"string"},"share_type":{"description":"视频流共享类型。\n- PRIVATE:非共享。\n- PUBLIC:共享。\n\n不区分大小写。","enum":["PUBLIC","PRIVATE"],"example":"PRIVATE","type":"string"},"state":{"description":"视频流状态,可选值如下。\n- ACTIVE:表示已激活。\n- STOPPED:表示已停用。","enum":["ACTIVE","STOPPED"],"example":"STOPPED","type":"string"},"tag":{"description":"和视频流关联的标签,一个视频流最多添加10个标签。","items":{"$ref":"#/definitions/StreamTag"},"maximum":10,"minimum":0,"type":"array"},"url":{"description":"HTTP-FLV视频流的拉流地址。URL必须是http或https协议的合法URL。格式要求:以“http://”或“https://”开头的字符串,例如“http://xxxx.xxx”。","example":"https://xxxxxxxx.com/live","type":"string"}}}},"description":null,"group_id":"5346b7c1dc284228a28795d5bcbd550d","host":"vis.cn-north-4.myhuaweicloud.com","id":"ca2857540a4f4e43af1e696bd9a3d1fc","info_version":"v1","method":"put","name":"UpdateStream","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}":{"put":{"consumes":[],"deprecated":false,"description":"该接口用于更新视频流的详情,包括RTMP以及HTTP-FLV类型视频流。","operationId":"UpdateStream","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****"},{"description":"更新视频流请求体","in":"body","name":"UpdateStreamRequest","required":false,"schema":{"$ref":"#/definitions/UpdateStreamRequestList"}}],"produces":[],"responses":{"200":{"description":"正常","examples":{"application/json":{"result":"success"}},"schema":{"$ref":"#/definitions/UpdateResponse"}},"400":{"description":"请求错误","examples":{"application/json":{"error_code":"VIS.0005","error_msg":"Invalid request parameter, url can not be null or empty when access type is HTTP-FLV."}}}},"summary":"更新视频流","tags":["视频流管理"],"x-apiexplorer-hide":"N","x-constraint":"当视频流处于ACTIVE状态时,不允许修改视频接入类型","x-is-registered":"Y","x-name":"更新视频流","x-request-examples-1":{"state":"ACTIVE"},"x-request-examples-url-1":"PUT /v1/3266392d188c47d09948b1**********/streams/streamTest","x-support-sdk":"Y"}}},"product_short":"VIS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"更新视频流","tags":"视频流管理","uri":null,"version":"2.0"}