Help Center/ Object Storage Service/ SDK Reference/ Go/ Bucket APIs (SDK for Go)/ Event Notifications (SDK for Go)/ Obtaining the Event Notification Configuration of a Bucket (SDK for Go)
Updated on 2026-08-14 GMT+08:00

Obtaining the Event Notification Configuration of 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 returns the event notification configurations of a bucket.

Restrictions

Method

func (obsClient ObsClient) GetBucketNotification(bucketName string) (output *GetBucketNotificationOutput, err error)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

string

Yes

Explanation:

Bucket name

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

Responses

Table 2 List of returned results

Parameter

Type

Description

output

*GetBucketNotificationOutput

Explanation:

Returned results. For details, see Table 3.

err

error

Explanation:

Error messages returned by the API

Table 3 GetBucketNotificationOutput

Parameter

Type

Description

StatusCode

int

Explanation:

HTTP status code

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

Default value:

None

ResponseHeaders

map[string][]string

Explanation:

HTTP response headers

Default value:

None

TopicConfigurations

[]TopicConfiguration

Explanation:

List of event notification configurations. For details, see Table 4.

Table 4 TopicConfiguration

Parameter

Type

Description

ID

string

Event notification ID

Topic

string

URN of the event notification topic. After detecting a specific event, OBS sends a message to the topic.

Events

[]EventType

Explanation:

List of the events for which notifications will be sent. For details, see Table 5.

FilterRules

[]FilterRule

Explanation:

List of filtering rules. For details, see Table 6.

Table 5 EventType

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

Table 6 FilterRule

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:

  • prefix: Objects can be filtered by prefixes.
  • suffix: Objects can be filtered by suffixes.

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.

Code Examples

This example returns the event notification configurations of 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
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())
    }
    // Specify a bucket name.
    bucketname := "examplebucket"
    // Obtain the event notification configurations of the bucket.
    output, err := obsClient.GetBucketNotification(bucketname)
    if err == nil {
        fmt.Printf("Get bucket(%s)'s notification successful!\n", bucketname)
        for index, topicConfiguration := range output.TopicConfigurations {
            fmt.Printf("TopicConfiguration[%d]\n", index)
            fmt.Printf("ID:%s, Topic:%s, Events:%v\n", topicConfiguration.ID, topicConfiguration.Topic, topicConfiguration.Events)
        }
        return
    }
    fmt.Printf("Get bucket(%s)'s notification fail!\n", bucketname)
    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)
    }
}