华为云计算 云知识 获取桶的消息通知配置GetBucketNotification
获取桶的消息通知配置GetBucketNotification

 

接口说明

获取指定桶的 消息通知 配置信息。

为了能成功执行此配置操作,需要确保执行者拥有GetBucketNotification权限。默认情况下只有桶的所有者拥有该权限,但可以通过设置桶策略或用户策略授权给其他用户。

URL
GET  https://obs.cn-north-4.myhuaweicloud.com/ 
请求参数
名称 类型 IN 必选 描述
Authorization
 
string header

请求消息中可带的签名信息。

Date
 
string header

请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默认值:无。 条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。

bucket_name
 
string query

请求的桶名称。

notification
 
string query

notification表示请求桶的消息通知配置API。

返回参数
返回码: 200

请求成功响应消息。

名称 类型 必选 描述
Content-Length
 
string

响应消息体的字节长度。

Connection
 
string

指明与服务器的连接是长连接还是短连接。

Date
 
string

OBS系统响应的时间。

ETag
 
string

对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。

x-obs-id-2
 
string

帮助定位问题的特殊符号。

x-obs-request-id
 
string

由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。

名称 类型 必选 描述
NotificationConfiguration
 
SetBucketNotificationRequestBody object

配置桶事件通知的根元素,如果子元素为空,说明消息通知功能处于关闭状态。

200 NotificationConfiguration
名称 类型 必选 描述
TopicConfiguration
 
Array of TopicConfiguration objects  
FunctionStageConfiguration
 
Array of FunctionStageConfiguration objects  
200 NotificationConfiguration.TopicConfiguration
名称 类型 必选 描述
Id
 
string

每项事件通知配置的唯一标识,若是用户未指定ID,系统将自动分配一个ID。

Filter
 
Filter object

Object的元素,用以保存过滤对象名的一组规则。

Topic
 
string

事件通知主题的URN,当OBS检测到桶中发生特定的事件后,将会发布通知消息至该主题,可以在消息通知服务主题部分找到具体值。 模板:<Topic>urn:smn:region:project_id:smn_topic</Topic>

Event
 
string

需要发布通知消息的事件类型。 说明:在一个TopicConfiguration、FunctionStageConfiguration配置项中可以添加多个事件类型。 合法值: 上传对象操作可以取以下值: ObjectCreated:Put ObjectCreated:Post ObjectCreated:Copy ObjectCreated:CompleteMultipartUpload

或者使用通配符支持所有上传操作 ObjectCreated:*

删除对象操作可以取以下值: ObjectRemoved:Delete ObjectRemoved:DeleteMarkerCreated

或者使用通配符支持所有删除操作 ObjectRemoved:*

200 NotificationConfiguration.TopicConfiguration.Filter
名称 类型 必选 描述
Object
 
FilterObject object

定义过滤规则的元素,该规则用以匹配对象名前缀和后缀。

200 NotificationConfiguration.TopicConfiguration.Filter.Object
名称 类型 必选 描述
FilterRule
 
Array of FilterRule objects  
200 NotificationConfiguration.TopicConfiguration.Filter.Object.FilterRule
名称 类型 必选 描述
Name
 
string

指定规则按对象名前缀或后缀进行过滤。

Value
 
string

指定的对象名关键字,根据Name元素定义的前缀或后缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高,最大可支持1024个字符。

200 NotificationConfiguration.FunctionStageConfiguration
名称 类型 必选 描述
Id
 
string

每项事件通知配置的唯一标识,若是用户未指定ID,系统将自动分配一个ID。

Filter
 
Filter object

Object的元素,用以保存过滤对象名的一组规则。

Topic
 
string

事件通知主题的URN,当OBS检测到桶中发生特定的事件后,将会发布通知消息至该主题,可以在消息通知服务主题部分找到具体值。 模板:<Topic>urn:smn:region:project_id:smn_topic</Topic>

Event
 
string

需要发布通知消息的事件类型。 说明:在一个TopicConfiguration、FunctionStageConfiguration配置项中可以添加多个事件类型。 合法值: 上传对象操作可以取以下值: ObjectCreated:Put ObjectCreated:Post ObjectCreated:Copy ObjectCreated:CompleteMultipartUpload

或者使用通配符支持所有上传操作 ObjectCreated:*

删除对象操作可以取以下值: ObjectRemoved:Delete ObjectRemoved:DeleteMarkerCreated

或者使用通配符支持所有删除操作 ObjectRemoved:*

FunctionStage
 
string

函数服务中函数的URN,当OBS检测到桶中发生特定的事件后,将会发送消息至函数服务调用执行该函数。 若添加父元素FunctionStageConfiguration,本元素是必选项。

200 NotificationConfiguration.FunctionStageConfiguration.Filter
名称 类型 必选 描述
Object
 
FilterObject object

定义过滤规则的元素,该规则用以匹配对象名前缀和后缀。

200 NotificationConfiguration.FunctionStageConfiguration.Filter.Object
名称 类型 必选 描述
FilterRule
 
Array of FilterRule objects  
200 NotificationConfiguration.FunctionStageConfiguration.Filter.Object.FilterRule
名称 类型 必选 描述
Name
 
string

指定规则按对象名前缀或后缀进行过滤。

Value
 
string

指定的对象名关键字,根据Name元素定义的前缀或后缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高,最大可支持1024个字符。

返回码: 400

请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。

错误码 描述 HTTP状态码
InvalidArgument 该错误可能是由于下列原因导致。指定了不支持的event。指定的URN不存在或者填写错误,请确认URN合法。指定的URN中的区域与桶所在的区域不一致,请确保桶所在的区域与URN中的区域一致。指定的过滤规则之间存在互相包含或者重叠。 400 Bad Request
AccessDenied 执行者不是桶的所有者,或者还未被授权PutBucketNotification权限。 403 Forbidden
名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

返回示例
返回码:200

请求成功响应消息。

示例 1
 
HTTP/1.1 200 OK Server: OBS x-obs-request-id: 900B000001643FDDD751B37BA87590D8 x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAA BCS JRBSladan5ZCVw6ZIY/DAs0zs6z7Hh Content-Type: application/xml Date: WED, 01 Jul 2015 03:16:32 GMT Content-Length: 490 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <NotificationConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <TopicConfiguration> <Topic>urn:smn:cn-east-3:4b29a3cb5bd64581bda5714566814bb7:tet522</Topic> <Id>ConfigurationId</Id> <Filter> <Object> <FilterRule> <Name>prefix</Name> <Value>object</Value> </FilterRule> <FilterRule> <Name>suffix</Name> <Value>txt</Value> </FilterRule> </Object> </Filter> <Event>ObjectCreated:Put</Event> </TopicConfiguration> </NotificationConfiguration>
SDK
点击  对象存储服务  (OBS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明

 

上一篇:密钥对管理服务有何优点 下一篇:云平台安全-数据安全相关技术介绍

应用使能 ROMA

应用使能 ROMA

华为云应用平台ROMA源自华为自身实践,聚焦数字化资产全生命周期治理,提供应用的开发、托管、运维和集成一站式能力,联合合作伙伴,基于实践快速构建行业使能服务,降低数字化系统成本,帮助客户构筑数字化应用平台,服务数字经济,繁荣伙伴生态。

华为云应用平台ROMA源自华为自身实践,聚焦数字化资产全生命周期治理,提供应用的开发、托管、运维和集成一站式能力,联合合作伙伴,基于实践快速构建行业使能服务,降低数字化系统成本,帮助客户构筑数字化应用平台,服务数字经济,繁荣伙伴生态。