Object Storage Service:GetBucketWorm

Usage notes

OSS supports the Write Once Read Many (WORM) strategy, which prevents objects from being deleted or overwritten for a specified period of time. You can configure a time-based retention policy for a bucket with a retention period ranging from one day to 70 years.

After a bucket's retention policy is locked, you can read objects from or upload objects to the bucket. However, the objects and the retention policy cannot be deleted within the retention period. You can delete objects only after the retention period expires.

Request headers

A GetBucketWorm request contains only common request headers. For more information, see Common request headers.

Response headers

The response to a GetBucketWorm request contains only common response headers. For more information, see Common response headers.

Response elements

Examples

• Sample request

  GET /? worm HTTP/1.1
  Date: Fri, 16 Oct 2020 11:18:32 GMT
  Host: BucketName.oss.aliyuncs.com
  Authorization: SignatureValue

• Sample response

  HTTP/1.1 200 OK
  x-oss-request-id: 5374A2880232A65C2300****
  Date: Fri, 16 Oct 2020 11:18:32 GMT
  Content-Type: application/xml
  Content-Length: length
  <WormConfiguration>
    <WormId>1666E2CFB2B3418****</WormId>
    <State>Locked</State>
    <RetentionPeriodInDays>1</RetentionPeriodInDays>
    <CreationDate>2020-10-15T15:50:32</CreationDate>
  </WormConfiguration>

OSS SDKs

The following OSS SDKs support the GetBucketWorm operation:

• Java

• Python V2

• Go V2

• Node.js

• C++

• PHP V2

ossutil

For the ossutil command that corresponds to the GetBucketWorm operation, see get-bucket-worm.