# 获取桶的事件通知配置(Go SDK) #### 功能介绍 OBS事件通知功能帮助您对桶的重要的操作进行实时监控，重要操作触发时可及时通知到您，确保您安全、及时知道发生在桶上的关键事件。 调用获取桶的事件通知配置接口，可获取指定桶的事件通知配置。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶的事件通知配置的权限，才能获取桶的事件通知配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketNotification权限，如果使用桶策略则需授予GetBucketNotification权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 **func** (obsClient ObsClient) GetBucketNotification([bucketName] string, extensions...extensionOptions) (output \*[GetBucketNotificationOutput], err error) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶命名规则如下： - 需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。用户删除桶后，立即创建同名桶或并行文件系统会创建失败，需要等待30分钟才能创建。 - 长度范围为3到63个字符，仅支持小写字母、数字、中划线（-）、英文句号（.）。 - 禁止两个英文句号（.）相邻，禁止英文句号（.）和中划线（-）相邻，禁止以英文句号（.）和中划线（-）开头或结尾。 - 禁止使用IP地址。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | extensions | [extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html) | 可选 | **参数解释：** 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考[extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html)。 | #### 返回结果说明 表2返回结果列表 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | output | \*[GetBucketNotificationOutput] | **参数解释：** 接口返回信息，详情参考[GetBucketNotificationOutput]。 | | err | error | **参数解释：** 接口返回错误信息。 | 表3GetBucketNotificationOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | StatusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | ResponseHeaders | map\[string\]\[\]string | **参数解释：** HTTP响应头信息。 **默认取值：** 无 | | TopicConfigurations | \[\][TopicConfiguration] | **参数解释：** 桶事件通知配置列表，详见[TopicConfiguration]。 | 表4TopicConfiguration | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | ID | string | 事件通知配置ID。 | | Topic | string | 事件通知主题的URN，当OBS检测到桶中发生特定的事件后，将会发布通知消息至该主题。 | | Events | \[\][EventType] | **参数解释：** 需要发布通知消息的事件类型列表，详见[EventType]。 | | FilterRules | \[\][FilterRule] | **参数解释：** 过滤规则列表，详见[FilterRule]。 | 表5EventType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObjectCreatedAll | ObjectCreated:\* | 所有创建对象操作的事件。 包含PUT上传对象、POST上传对象、复制对象、合并段。 | | ObjectCreatedPut | ObjectCreated:Put | PUT上传对象的事件。 | | ObjectCreatedPost | ObjectCreated:Post | POST上传对象的事件。 | | ObjectCreatedCopy | ObjectCreated:Copy | 复制对象的事件。 | | ObjectCreatedCompleteMultipartUpload | ObjectCreated:CompleteMultipartUpload | 合并段的事件。 | | ObjectRemovedAll | ObjectRemoved:\* | 所有调用删除、取消段接口的对象操作的事件。 包含指定对象版本号删除对象；多版本开启后，不指定对象版本号删除对象。 | | ObjectRemovedDelete | ObjectRemoved:Delete | 指定对象版本号删除对象的事件。 | | ObjectRemovedDeleteMarkerCreated | ObjectRemoved:DeleteMarkerCreated | 多版本开启后，不指定对象版本号删除对象的事件。 | 表6FilterRule | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Name | string | 作为请求参数时可选 | 指定规则按对象名前缀或者后缀进行过滤，二者选一。支持的值： - prefix：按对象名前缀进行过滤 - suffix：按对象名后缀进行过滤 | | Value | string | 作为请求参数时可选 | 指定的对象名关键字，用以按照前缀或者后缀过滤对象。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3、和ExampleObject.jpg。如果您将logs/指定为前缀，将过滤出以字符串"logs/"开头的三个对象。如果您指定jpg为后缀，将过滤出以字符串"jpg"结尾的ExampleObject.jpg对象。 | #### 代码示例 本示例用于获取名为examplebucket桶的事件通知配置。 ``` package main import ( "fmt" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" "os" ) func main() { //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK。 ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。 securityToken := os.Getenv("SecurityToken") // endpoint填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken)) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } // 指定存储桶名称 bucketname := "examplebucket" // 获取桶事件通知配置 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) } } ``` #### 相关链接 - 更多关于获取桶的事件通知配置的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-go-obs/blob/master/examples/bucket_operations_sample.go)。 - 获取桶的事件通知配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 事件通知相关常见问题请参见[事件通知相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_0900.html)。