Configuring Event Notifications for a Bucket (SDK for Go)
Function
You can configure notifications for certain types of events. When such events happen in your bucket, you will be notified of the operations in a timely manner.
This API configures event notifications for a bucket.
Restrictions
- To configure event notifications for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketNotification in IAM or PutBucketNotification in a bucket 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) SetBucketNotification(input *SetBucketNotificationInput) (output *BaseModel, err error)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| input | Yes | Input parameters for configuring event notifications |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Bucket | string | Yes | Explanation: Bucket name Restrictions:
Value range: The value must contain 3 to 63 characters. |
| TopicConfigurations | No | List of event notification configurations |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| ID | string | No if used as a request parameter | Event notification ID |
| Topic | string | Yes if used as a request parameter | URN of the event notification topic. After detecting a specific event, OBS sends a message to the topic. |
| Events | Yes if used as a request parameter | List of the events for which notifications will be sent | |
| FilterRules | No if used as a request parameter | List of filtering rules |
| Constant | Default Value | Description |
|---|---|---|
| ObjectCreatedAll | ObjectCreated:* | All events for creating object through PUT, POST, Copy, Combine methods |
| ObjectCreatedPut | ObjectCreated:Put | PUT Object events |
| ObjectCreatedPost | ObjectCreated:Post | POST Object events |
| ObjectCreatedCopy | ObjectCreated:Copy | PUT Object - Copy events |
| ObjectCreatedCompleteMultipartUpload | ObjectCreated:CompleteMultipartUpload | Complete Multipart Upload events |
| ObjectRemovedAll | ObjectRemoved:* | Events of calling the APIs for deletion and aborting multipart uploads Events for deleting objects without specifying object version IDs, when versioning is enabled, as well as deleting objects by specifying object version IDs |
| ObjectRemovedDelete | ObjectRemoved:Delete | Events for deleting objects by specifying object version IDs |
| ObjectRemovedDeleteMarkerCreated | ObjectRemoved:DeleteMarkerCreated | Events for deleting objects without specifying object version IDs, when versioning is enabled |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Name | string | No if used as a request parameter | Prefix or suffix of object names for filtering. Possible values are:
|
| Value | string | No if used as a request parameter | Keyword of object names for filtering objects by prefix or suffix Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you specify logs/ as the prefix, logs/day1, logs/day2, and logs/day3 will be returned. If you specify jpg as the suffix, ExampleObject.jpg will be filtered. |
Responses
| Parameter | Type | Description |
|---|---|---|
| output | Explanation: Returned results. For details, see Table 7. | |
| err | error | Explanation: Error messages returned by the API |
| 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 |
Code Examples
This example configures event notifications for bucket examplebucket.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | 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 advised not to use hard coding to reduce leakage risks. 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.SetBucketNotificationInput{} // Specify a bucket name. input.Bucket = "examplebucket" // Specify event notifications for the bucket. input.TopicConfigurations = []obs.TopicConfiguration{ { ID: "001", Topic: "topic", Events: []obs.EventType{obs.ObjectCreatedAll}, FilterRules: []obs.FilterRule{ {Name: "prefix", Value: "smn"}, {Name: "suffix", Value: ".jpg"}, }, }, } // Configure event notifications for the bucket. output, err := obsClient.SetBucketNotification(input) if err == nil { fmt.Printf("Set bucket(%s)'s notification successful!\n", input.Bucket) fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Set bucket(%s)'s notification fail!\n", input.Bucket) 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