
# 设置桶的多版本状态-SetBucketVersioning
#### 功能介绍
多版本功能可在用户意外覆盖或删除对象的情况下提供一种恢复手段。用户可以使用多版本功能来保存、检索和还原对象的各个版本，这样用户能够从意外操作或应用程序故障中轻松恢复数据。多版本功能还可用于数据保留和存档。可通过本接口设置桶的多版本状态，用来开启或暂停桶的多版本功能。了解更多多版本状态相关信息，请参见[多版本控制](https://support.huaweicloud.com/usermanual-obs/obs_03_0327.html)。
#### 接口约束
- 多版本控制一旦启动，不可关闭，只能暂停使用。
- 开启了桶级[WORM](https://support.huaweicloud.com/usermanual-obs/obs_03_0718.html)开关，需要先开启多版本控制。使用控制台配置WORM时，控制台会自动开启多版本，并且不允许暂停多版本。使用API配置WORM时，需要您自行调用[设置桶的多版本状态](https://support.huaweicloud.com/api-obs/obs_04_0037.html)接口开启多版本。
- 不支持对历史版本对象配置ACL、服务端加密和标签。
 
#### 授权信息
您必须是桶拥有者或拥有设置桶的多版本状态的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见[OBS不同权限控制方式的区别](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)。
- 如果使用**IAM授权** ，那么请在"角色与策略授权"、"身份策略授权"两种IAM授权方式中选择一种，并配置相应权限：
  - 如果使用**角色与策略授权** （旧版IAM，即IAM v3接口），需具备**obs:bucket:PutBucketVersioning** 权限，授权操作请参见[创建IAM自定义策略](https://support.huaweicloud.com/usermanual-iam/iam_01_0605.html)。
  
  - 如果使用**身份策略授权** （新版IAM，即IAM v5接口），如下表所示，需具备**obs:bucket:putBucketVersioning** 权限，授权操作请参见[创建IAM自定义身份策略](https://support.huaweicloud.com/usermanual-iam5/iam_01_0917.html)。
    
    | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | [条件键](https://support.huaweicloud.com/api-obs/obs_04_0112.html#ZH-CN_TOPIC_0000002375307974__condition_table) Condition Key                                                                                                                                                                                                                                                                                                | [别名](https://support.huaweicloud.com/iam5_faq/iam_01_1103.html) Alias | 依赖的授权项 Dependencies |
    |:---|:---|:---|:---|:---|:---|
    | obs:bucket:putBucketVersioning                      | Write                                                      | bucket \*                                                                        | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2)  - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2)                               | -                                                                                                            | -                                                         |
    | obs:bucket:putBucketVersioning                      | Write                                                      | -                                                                                | - obs:EpochTime  - obs:SourceIp  - obs:TlsVersion  - obs:CustomDomain   | -                                                                                                            | -                                                         |
       
    
   
- 如果使用**桶策略** 进行授权，需具备**obs:bucket:PutBucketVersioning** 权限，具体操作请参见[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。
 
#### URI
PUT /
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-obs/obs_04_0006.html)。调用前需要先[计算API签名](https://support.huaweicloud.com/api-obs/obs_04_0009.html)，并将签名添加到请求中。
您还可以使用[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OBS/doc?api=SetBucketVersioning)在线调试接口。
#### 请求消息样式
```
PUT /?versioning HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Date: date
Authorization: authorization
Content-Length: length
<VersioningConfiguration> 
    <Status>status</Status> 
</VersioningConfiguration>
```
#### URI参数（URI Parameters）
该请求通过URI中的versioning参数标识多版本配置操作。
#### 请求头参数（Request headers）
该请求使用公共请求头，具体参见[表3](https://support.huaweicloud.com/api-obs/obs_04_0007.html#ZH-CN_TOPIC_0136436606__table25197309)。
#### 请求体参数（Request body）
在此请求中，需要在请求的消息体中配置桶的多版本状态，配置信息以XML格式上传。具体的配置元素如[表1]描述。
 表1桶的多版本状态配置元素 
| **参数名称**                | 参数类型   | 是否必选 | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| VersioningConfiguration | XML    | 是    | **参数解释：** 多版本配置的根节点，是Status的父节点。 **约束限制：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                      |
| Status                  | String | 是    | **参数解释：** 标识桶的多版本状态。 **约束限制：** 不涉及 **取值范围：** - Enabled：开启多版本控制  - Suspended：暂停多版本控制   **默认取值：** 不涉及 |
   
#### 响应消息样式
```
HTTP/1.1 status_code
Date: date
Content-Length: length
```
#### 响应头 (Response Headers)
该请求的响应消息使用公共响应头，具体请参考[表1](https://support.huaweicloud.com/api-obs/obs_04_0013.html#ZH-CN_TOPIC_0173612084__d0e686)。
#### 响应体 (Response Body)
本接口的响应消息中不携带响应体。
#### 错误响应消息
无特殊错误，所有错误已包含在[错误码概述](https://support.huaweicloud.com/api-obs/obs_04_0115.html)中。
#### 请求示例
```
PUT /?versioning HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: Wed, 01 Jul 2015 03:14:18 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo=
Content-Length: 89
<VersioningConfiguration>     
    <Status>Enabled</Status> 
</VersioningConfiguration>
```
#### 响应示例
```
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF26000001643672B973EEBC5FBBF909
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSH6rPRHjQCa62fcNpCCPs7+1Aq/hKzE
Date: Wed, 01 Jul 2015 03:14:18 GMT
Content-Length: 0
```
#### 请求示例：暂停版本控制
```
PUT /?versioning HTTP/1.1
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:iqSPeUBl66PwXDApxjRKk6hlcN4=
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.myhuaweicloud.com
Date: Wed, 01 Jul 2015 02:37:22 GMT
Content-Type: application/xml
 
<VersioningConfiguration>
    <Status>Suspended</Status>
</VersioningConfiguration>
```
#### 响应示例：暂停版本控制
```
HTTP/1.1 200 OK
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSjqfl2JttwovZb7kTM+xkyQQyhNyOOC
x-obs-request-id: 0000018A2C044BC6D24722440C5EC81C
Server: OBS
Content-Length: 0
Date: Wed, 01 Jul 2015 02:37:22 GMT
```
#### 使用SDK调用接口
建议您使用OBS SDK调用接口。SDK对API进行了封装以简化您的开发工作，直接调用SDK接口函数即可访问OBS，无需手动计算签名。
| [Java](https://support.huaweicloud.com/sdk-java-devg-obs/obs_21_1002.html) | [Python](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_0827.html) | [C](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0802.html) | [Go](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0429.html) | [BrowserJS](https://support.huaweicloud.com/sdk-browserjs-devg-obs/obs_24_0902.html) | [.NET](https://support.huaweicloud.com/sdk-dotnet-devg-obs/obs_25_0802.html) | [Android](https://support.huaweicloud.com/sdk-android-devg-obs/obs_26_0802.html) | [iOS](https://support.huaweicloud.com/sdk-ios-devg-obs/obs_27_0802.html) | [PHP](https://support.huaweicloud.com/sdk-php-devg-obs/obs_28_0802.html) | [Node.js](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0802.html) |
|---|---|---|---|---|---|---|---|---|---|
   
#### 相关文档
- 了解更多多版本状态相关信息，请参见[多版本控制](https://support.huaweicloud.com/usermanual-obs/obs_03_0327.html)。
- API操作涉及的计费项参见[计费项](https://support.huaweicloud.com/price-obs/obs_42_0002.html)。
 
