• Object Storage Service

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

Responses

Syntax

HTTP/1.1 status_code 
 Server: Server Name 
 x-amz-request-id: request id 
 x-reserved: amazon, aws and amazon web services are trademarks or registered trademarks of Amazon Technologies, Inc 
 x-amz-bucket-region: region name
 x-amz-id-2: id  
 Content-Type: type 
 Date: date
 Content-Length: length 

<Response Body>

Response Headers

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

In addition to common headers, when CORS is configured for buckets, you can use the response headers in Table 1.

Table 1 Appended response headers

Header

Description

Access-Control-Allow-Origin

If Origin in the request meets the CORS configuration requirements, Origin is included in the response.

Type: String

Access-Control-Allow-Headers

CORS is configured for buckets. If headers in the request meet the CORS configuration requirements, headers are included in the response.

Type: String

Access-Control-Max-Age

Indicates MaxAgeSeconds in the CORS configuration of a server.

Type: Integer

Access-Control-Allow-Methods

If Access-Control-Request-Method in the request meets the CORS configuration requirements, methods in the rule are included in the response.

Type: String

Valid values: GETPUTHEADPOST, and DELETE

Access-Control-Expose-Headers

Indicates ExposeHeader in the CORS configuration of a server.

Type: String

x-amz-bucket-region

Indicates the region of the bucket.

Type: String

Response Elements

This response contains the XML list of the objects in a bucket. Table 2 describes the elements in the XML list.

Table 2 Response elements

Element

Description

ListBucketResult

A list of objects in a bucket

Type: XML

Contents

Metadata of the objects

Type: XML

Parent node: ListBucketResult

CommonPrefixes

Grouping information. If you specify a delimiter in the request, the response contains grouping information in CommonPrefixes.

Type: XML

Parent node: ListBucketResult

Delimiter

The delimiter parameter specified in a request

Type: String

Parent node: ListBucketResult

DisplayName

Name of an object owner

Type: String

Parent node: ListBucketResult.Contents.Owner

ETag

The MD5 value of an object. (If an object is encrypted using server-side encryption, the ETag value is not the MD5 value of the object.)

Type: String

Parent node: ListBucketResult.Contents

ID

DomainId of an object owner

Type: String

Parent node: ListBucketResult.Contents.Owner

IsTruncated

Determines whether the returned list is truncated. true indicates that the result is incomplete while false indicates that the result is complete.

Type: Boolean

Parent node: ListBucketResult

Key

Name of an object

Type: String

Parent node: ListBucketResult.Contents

LastModified

Date and time when the last modification was made to an object

Type: Date

Parent node: ListBucketResult.Contents

Marker

Start point for listing objects

Type: String

Parent node: ListBucketResult

NextMarker

A marker for the last returned object in the list. NextMarker is returned when not all the objects are listed. You can set the Marker value to list the remaining objects in follow-up requests.

Type: String

Parent node: ListBucketResult

MaxKeys

The maximum objects returned.

Type: String

Parent node: ListBucketResult

Name

Name of the requested bucket

Type: String

Parent node: ListBucketResult

Owner

User information, including the DomainId and name

Type: XML

Parent node: ListBucketResult.Contents

Prefix

Prefix of an object key. Only objects whose keys have this prefix are listed.

Type: String

Parent node: ListBucketResult

Size

Number of bytes of an object

Type: String

Parent node: ListBucketResult.Contents

StorageClass

Storage class of an object

Type: String

Values: STANDARD | STANDARD_IA |GLACIER

Parent node: ListBucketResult.Contents

Error Responses

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