设置桶的事件通知配置(Go SDK)
功能介绍
OBS事件通知功能帮助您对桶的重要的操作进行实时监控,重要操作触发时可及时通知到您,确保您安全、及时知道发生在桶上的关键事件。
调用设置桶的事件通知配置接口,可为指定桶设置事件通知配置。
接口约束
- 您必须是桶拥有者或拥有设置桶的事件通知配置的权限,才能设置桶的事件通知配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutBucketNotification权限,如果使用桶策略则需授予PutBucketNotification权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
func (obsClient ObsClient) SetBucketNotification(input *SetBucketNotificationInput, extensions...extensionOptions) (output *BaseModel, err error)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| input | 必选 | 设置桶的事件通知配置请求参数。 | |
| extensions | 可选 | 参数解释: 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头,详情参考extensionOptions。 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | string | 必选 | 参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 |
| TopicConfigurations | 可选 | 桶事件通知配置列表。 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| ID | string | 作为请求参数时可选 | 事件通知配置ID。 |
| Topic | string | 作为请求参数时必选 | 事件通知主题的URN,当OBS检测到桶中发生特定的事件后,将会发布通知消息至该主题。 |
| Events | 作为请求参数时必选 | 需要发布通知消息的事件类型列表。 | |
| FilterRules | 作为请求参数时可选 | 过滤规则列表。 |
| 常量名 | 原始值 | 说明 |
|---|---|---|
| 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 | 多版本开启后,不指定对象版本号删除对象的事件。 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Name | string | 作为请求参数时可选 | 指定规则按对象名前缀或者后缀进行过滤,二者选一。支持的值:
|
| Value | string | 作为请求参数时可选 | 指定的对象名关键字,用以按照前缀或者后缀过滤对象。 例如,假设您拥有以下对象:logs/day1、logs/day2、logs/day3、和ExampleObject.jpg。如果您将logs/指定为前缀,将过滤出以字符串“logs/”开头的三个对象。如果您指定jpg为后缀,将过滤出以字符串“jpg”结尾的ExampleObject.jpg对象。 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| StatusCode | int | 参数解释: HTTP状态码。 约束限制: 无 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值: 无 |
| RequestId | string | 参数解释: OBS服务端返回的请求ID。 约束限制: 无 取值范围: 无 默认取值: 无 |
| ResponseHeaders | map[string][]string | 参数解释: HTTP响应头信息。 约束限制: 无 取值范围: 无 默认取值: 无 |
代码示例
本示例用于设置名为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 | package main import ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 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()) } input := &obs.SetBucketNotificationInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定桶事件通知配置列表 input.TopicConfigurations = []obs.TopicConfiguration{ { ID: "001", Topic: "topic", Events: []obs.EventType{obs.ObjectCreatedAll}, FilterRules: []obs.FilterRule{ {Name: "prefix", Value: "smn"}, {Name: "suffix", Value: ".jpg"}, }, }, } // 设置桶事件通知配置 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) } } |
相关链接
- 更多关于设置桶的事件通知配置的示例代码,请参见Github示例。
- 设置桶的事件通知配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 事件通知相关常见问题请参见事件通知相关常见问题。