文档首页 > > API参考> API> 视频流管理> 更新转储信息

更新转储信息

分享
更新时间: 2019/12/04 GMT+08:00

功能介绍

此接口用于更新视频转储信息。创建的视频流默认没有转储信息,即视频数据不会保存。更新转储信息后可以将视频流保存到指定的存储媒介,如OBS。后续用户可以从OBS上获取到转储的视频。

  • 如果转储到OBS,在调用该API之前,需要您先授予VIS操作OBS的权限,授权操作只需要操作一次即可,后续转储无需再操作。授权方法如下:
    1. 登录视频接入服务控制台
    2. “视频流管理”页面,找到您需要转储的已激活视频流,单击操作列的“开始转储”
    3. 如果您之前没有OBS授权,则系统会提示您进行OBS授权,单击“同意授权”即可。
  • 如果转储到OBS,最终生成的视频文件路径为“/OBS路径/视频流名称/year/month/day/hour/startmin.sec_endmin.sec.flv”,例如“obs:path/to/video/streamName/2018/8/18/18/0100_0200.flv”

URI

  • URI格式
    PUT /v1/{project_id}/streams/{stream_name}/retention
  • 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

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

    stream_name

    String

    视频流名称。

请求

  • 请求样例
    PUT /v1/{project_id}/streams/streamTest/retention
    {
        "retention_in_hour": 100000,
        "retention_forever": false,
        "store_type": "obs",
        "bucket": "obs-momo",
        "path": "path/to/video/",
        "slice_in_minute": 1,
        "timezone": "GMT+8:00",
        "state": "ACTIVE"
    }
  • 参数说明

    参数

    是否必选

    类型

    说明

    retention_in_hour

    String

    转储时长,即视频保存的时长,以小时为单位。第一次创建转储信息时必选。

    可选值范围0~87600,即最大保存时长为10年。

    说明:
    1. 当转储处于激活状态时,系统每隔1小时检查已转储的视频是否超过转储时长:
      1. 当目录下面所有的视频都过期时,系统会清理过期视频,该目录及数据会被删除。
      2. 当目录下只有部分视频过期时,则该目录与数据会被保留。只有在目录下面所有的视频都过期时才会清理,并且清理存在延时。
    2. 转储时长为0的时候可以转储,但每隔1小时会被清理。
    3. 当转储处于停止状态时,系统不会进行定时清理操作。

    retention_forever

    Boolbean

    选择视频是否永久保存:

    • true:永久保存,系统不会进行定时删除清理,retention_in_hour字段(转储时长参数)将失效,可缺省。
    • false:不永久保存。

    store_type

    String

    视频转储位置,可为“obs”,即存储到云服务OBS上。

    第一次创建转储信息时必选,不区分大小写。

    bucket

    String

    OBS桶名,当“store_type”“obs”时必选。

    path

    String

    OBS目录,当“store_type”“obs”时,该参数必选。

    该目录下的文件夹最多为N+2个,N为转储时长。

    slice_in_minute

    Integer

    分片长度,以分钟为单位。

    取值范围为1~60,默认为5。

    timezone

    String

    当地时区。格式为GMT+HH:00,如GMT+8:00表示东八区。转储时路径命名以该时区时间为准。

    state

    String

    转储状态:
    • ACTIVE:表示进行转储。
    • STOPPED:表示停止转储。

    默认为STOPPED。

响应

  • 成功时,响应样例:
    {
         "result": "success"
    }
  • 失败时,返回如下参数:

    参数

    说明

    error_code

    错误码。

    error_msg

    错误消息,详见错误码说明

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

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

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

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

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区