• Object Storage Service

obs
  1. Help Center
  2. Object Storage Service
  3. API Reference (OBS)
  4. Operations on Buckets
  5. GET Bucket Notification
  6. Responses

Responses

Syntax

HTTP/1.1 status_code 
x-amz-request-id: id 
x-amz-id-2: id 
x-reserved: reserved info 
Content-Type: type 
Date: date 
Content-Length: lenth 

<?xml version="1.0" encoding="UTF-8"?> 
<NotificationConfiguration xmlns="http://obs.example.com/doc/2015-06-30/">
 <TopicConfiguration>
  <Id>topic_001</Id>
  <Topic>urn:smn:example:35667523564:topic001</Topic>
  <Event>s3:ObjectCreated:*</Event>
  ....
 </TopicConfiguration> 
</NotificationConfiguration>

Response Headers

This response uses common headers. For details, see section Common Response Headers.

Response Elements

The following table describes the elements contained in this response.

Table 1 Response elements

Element

Description

NotificationConfiguration

Container for configuring the event notification function of a bucket. If this element is null, the function is disabled.

Type: Container

Ancestor: None

Children: one TopicConfiguration or TopicConfigurations

TopicConfiguration

Container for configuring the event notification topic

Type: Container

Ancestor: NotificationConfiguration

Children: Id, Filter, Topic, Event or Events

Topic

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

Type: String

Ancestor: TopicConfiguration

Id

Unique ID of each event notification. If the user does not specify an ID, the system assigns an ID automatically.

Type: String

Ancestor: TopicConfiguration

Filter

Container of S3Key used to store rules of filtering object names

Type: Container

Ancestor: TopicConfiguration

Children: S3Key

S3Key

Container of S3Key used to store rules of filtering object names

Type: Container

Ancestor: TopicConfiguration

Children: Name,Value

FilterRule

Container that defines key-value pairs of filtering rules

Type: Container

Ancestor: S3Key

Children: Name, Value

Name

Specifies the prefix or suffix of object names for filtering The value contains a maximum of 1024 characters.

Type: String

Ancestor: FilterRule

Legal value: prefix or suffix

Value

Specifies keywords of object names so that objects can be filtered based on the prefixes or suffixes.

Type: String

Ancestor: FilterRule

Event

Type of events that need to be notified

NOTE:

Multiple event types can be added in one TopicConfiguration configuration item.

Type: String

Ancestor: TopicConfiguration

Error Responses

No special error responses are returned. For details about error responses, see Table 1..