Help & DocumentationCloud Object StorageAPI DocumentationBucket-related APIsVersioningPUT Bucket versioning

PUT Bucket versioning

Last updated: 2019-09-24 17:33:07

PDF

Contents：

Description

The PUT Bucket versioning API is used to enable or suspend versioning for a bucket.

Notes

  1. If you have never enabled versioning for the bucket, GET Bucket versioning will not return a versioning state value.
  2. Once enabled, versioning can only be suspended but cannot be disabled.
  3. Set the versioning state value to Enabled or Suspended to enable or suspend versioning, respectively.
  4. To set versioning for a bucket, you need to have the permission to write to the bucket.

Request

Sample Request

PUT /?versioning HTTP 1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT date
Authorization: Auth String

Authorization: Auth String (see Request Signature for more information).

Request Headers

Common Headers

The implementation of this request uses a common request header. For more information on common request headers, see Common Request Headers.

Special Headers

This request does not use any special request header.

Request Body

<VersioningConfiguration>
  <Status></Status>
</VersioningConfiguration>

Please find the details below:

Node Name (Keyword) Parent Node Description Type
VersioningConfiguration None Describes the detailed information on versioning Container
Status VersioningConfiguration Indicates whether versioning is enabled; enumerators: Suspended, Enabled Enum

Response

Response Headers

Common Response Headers

This response contains a common response header. For more information on common response headers, see Common Response Headers.

Special Response Headers

This response does not have special response headers.

Response Body

This response body is empty.

Error Codes

Some common special errors that may occur with the request are listed below. For more COS error codes or a complete list of errors, see Error Codes.

Error Code HTTP Status Code Description
InvalidArgument 400 Bad Request If the xml body of the request to enable versioning is empty, InvalidArgument will be returned
InvalidDigest 400 Bad Request 1. The Content-MD5 carried does not match the request body calculated by the server;
2. Only two values are valid for the versioning state: Enabled or Suspended. If other values are entered, InvalidArgument will be returned

Samples

PUT /?versioning HTTP/1.1
Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.com
Connection: keep-alive
Accept-Encoding: gzip, deflate
Accept: */*
User-Agent: python-requests/2.12.4
Content-Type: application/xml
Authorization: q-sign-algorithm=sha1&q-ak=AKID15IsskiBQKTZbAo6WhgcBqVls9Sm****&q-sign-time=1480932292;1981012292&q-key-time=1480932292;1981012292&q-url-param-list=versioning&q-header-list=host&q-signature=47ec2b80c73788ecd394d3b9ad90e120a32f****
Content-Length: 83

<VersioningConfiguration>
    <Status>Enabled</Status>
</VersioningConfiguration>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 0
Connection: keep-alive
Date: Wed, 23 Aug 2017 08:14:53 GMT
Server: tencent-cos
x-cos-request-id: NTk5ZDM5N2RfMjNiMjM1MGFfMmRiX2Y0****