# 更新转储信息
#### 功能介绍
此接口用于更新视频转储信息。创建的视频流默认没有转储信息，即视频数据不会保存。更新转储信息后可以将视频流保存到指定的存储媒介，如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/0000_0200.flv。"
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=VIS&api=UpdateRetention)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
PUT /v1/{project_id}/streams/{stream_name}/retention
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                             |
|:---|:---|:---|:---|
| project_id  | 是    | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-vis/vis_03_0005.html) |
| stream_name | 是    | String | 视频流名称                                                                          |
#### 请求参数
表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参数 
| 参数              | 是否必选 | 参数类型    | 描述                                                       |
|:---|:---|:---|:---|
| 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。     |
| format          | 否    | String  | 视频流转储格式。 - H264支持MP4和FLV - H265只支持MP4 默认为FLV。            |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数     | 参数类型   | 描述      |
|:---|:---|:---|
| result | String | 处理成功时返回 |
   
#### 请求示例
```
PUT /v1/3266392d188c47d09948b1**********/streams/streamTest/retention
{
  "store_type" : "obs",
  "bucket" : "obs-momo",
  "path" : "path/**/video/***",
  "slice_in_minute" : 1,
  "timezone" : "GMT+8:00",
  "state" : "ACTIVE"
}
```
#### 响应示例
**状态码： 200**
正常
```
{
  "result" : "success"
}
```
**状态码： 400**
请求错误。具体返回错误码请参考[错误码说明](https://support.huaweicloud.com/api-vis/vis_03_0047.html)
```
{
  "error_msg" : "The entered stream ID does not exist.",
  "error_code" : "VIS.0202"
}
```
#### 状态码
| 状态码 | 描述                                                                               |
|:---|:---|
| 200 | 正常                                                                               |
| 400 | 请求错误。具体返回错误码请参考[错误码说明](https://support.huaweicloud.com/api-vis/vis_03_0047.html) |