You can call this operation to query the retention policy configured for the specified bucket.
OSS supports the Write Once Read Many (WORM) strategy that prevents an object from being deleted or overwritten for a specified period of time. You can configure a time-based retention policy for a bucket. A retention policy has a retention period that ranges from one day to 70 years.
After a retention policy configured for a bucket is locked, you can read objects from or upload objects to the bucket. However, the retention policy and objects in the bucket cannot be deleted within the retention period. You can delete objects in the bucket only after the retention period expires.
A GetBucketWorm request contains only common request headers. For more information, see Common request headers.
The response to a GetBucketWorm request contains only common response headers. For more information, see Common response headers.
|WormConfiguration||Container||The root node.
Child nodes: WormId, State, RetentionPeriodInDays, and CreationDate
|WormId||String||The ID of the retention policy.|
|State||String||The status of the retention policy.
|RetentionPeriodInDays||Positive integer||The number of days for which objects can be retained.|
|CreationDate||String||The time when the retention policy is created.|
- 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>