Configuring WORM Retention for an Object
Function
This API is used to configure or update the retention period for objects uploaded to a bucket with WORM enabled.
- If you did not configure a retention period or apply the default bucket-level retention policy when uploading an object, you can call this API to configure a retention period for the object.
- If you already configured a retention period or applied the default bucket-level retention policy when uploading an object, you can call this API to prolong the retention period for the object.
- The retention period of an object can only be modified, but not deleted.
Restrictions
- To call this API, you must be the bucket owner or have the permission (obs:bucket:PutBucketObjectLockConfiguration granted using IAM or PutBucketObjectLockConfiguration granted using a bucket policy) to set a bucket-level WORM retention policy. For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
Method
func (obsClient ObsClient) PutObjectRetention(input *PutObjectRetentionInput) (output *BaseModel, err error)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| input | Yes | Explanation: Request parameters for configuring a WORM policy for an object. For details, see Table 2. |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Bucket | string | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
| Key | string | Yes | Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
| VersionId | string | No | Explanation: ID of the object version to be deleted, for example, G001117FCE89978B0000401205D5DC9. Value range: The value must contain 32 characters. Default value: None. If this parameter is left blank, the latest version of the object is deleted. |
| RetentionMode | string | Yes | Explanation: Retention period for the object. Its value is a timestamp accurate to milliseconds, for example, 1435728035000 (corresponding to 13:20:35 on July 1, 2015). Example: 1435728035000 Restrictions: The specified time must be later than the current time and can be extended but not shortened. Value range: N/A Default value: N/A |
| RetainUntilDate | int64 | Yes | Explanation: Retention policy of the object. Restrictions: N/A Value range: COMPLIANCE: compliance mode Default value: N/A |
Responses
| Parameter | Type | Description |
|---|---|---|
| output | Explanation: Returned results. For details, see Table 4. | |
| err | error | Explanation: The error message returned by the server. |
| Parameter | Type | Description |
|---|---|---|
| StatusCode | int | Explanation: HTTP status code Restrictions: None Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None |
| RequestId | string | Explanation: Request ID returned by the OBS server Restrictions: None Value range: None Default value: None |
| ResponseHeaders | map[string][]string | Explanation: HTTP response headers Restrictions: None Value range: None Default value: None |
Sample Code
package main
import (
"fmt"
"os"
obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
// Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
// Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak := os.Getenv("AccessKeyID")
sk := os.Getenv("SecretAccessKey")
// (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
securityToken := os.Getenv("SecurityToken")
// Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
// Create an obsClient instance.
// If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
if err != nil {
fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
}
input := &obs.PutObjectRetentionInput{}
// Specify a bucket name.
input.Bucket = "examplebucket"
// Specify an object (example/objectname as an example).
input.Key = "example/objectname"
input.RetentionMode = string(obs.WormRetentionModeCompliance)
input.RetainUntilDate = retainUntilDate
// Configure a WORM policy for the object.
output, err := obsClient.PutObjectRetention(bucketName)
if err == nil {
fmt.Printf("Set object retention successfully!\n")
fmt.Printf("RequestId:%s\n", output.RequestId)
return
}
fmt.Printf("Set object retention fail!\n")
if obsError, ok := err.(obs.ObsError); ok {
fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
fmt.Println(obsError.Error())
} else {
fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
fmt.Println(err)
}
} What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot