• Object Storage Service

obs
  1. Help Center
  2. Object Storage Service
  3. API Reference (PHP SDK)
  4. Bucket-Related APIs
  5. GET Objects

GET Objects

API Description

You can use this API to list objects in a bucket. By default, a maximum of 1000 objects are listed.

Method Definition

1. ObsClient->listObjects(array $parameter)
2. ObsClient->listObjectsAsync(array $parameter, callable $callback)

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

string

Mandatory

Bucket name

Prefix

string

Optional

Prefix that the object names to be listed must contain

Marker

string

Optional

Object name to start with when listing objects in a bucket. All objects are listed in the lexicographical order.

MaxKeys

integer

Optional

Maximum number of objects returned in the response. The value ranges from 1 to 1000. If the value is not in this range, 1000 is returned by default.

Delimiter

string

Optional

Character used to group object names. If the object name contains the Delimiter parameter, the character string from the first character to the first delimiter in the object name is grouped under a single result element, CommonPrefix. (If a prefix is specified in the request, the prefix must be removed from the object name.)

Returned Result

Field

Type

Description

HttpStatusCode

integer

HTTP status code

Reason

string

Reason description

RequestId

string

Request ID returned by the OBS server

Location

string

Bucket location

Name

string

Bucket name

Delimiter

string

Character used to group object names, which is consistent with that set in the request

IsTruncated

boolean

Whether all objects are returned. If the field value is true, not all objects are returned. If the field value is false, all objects are returned.

Prefix

string

Object name prefix, which is consistent with that set in the request

Marker

string

Start position for listing objects, which is consistent with that set in the request

NextMarker

string

Object name to start with upon next request for listing objects

MaxKeys

integer

Maximum number of listed objects, which is consistent with that set in the request

Contents

indexed array

Object list. This field contains the following parameters:

  • ETag
  • Size
  • StorageClass
  • Key
  • LastModified
  • Owner

ETag

string

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

Size

integer

Object size in bytes

StorageClass

string

Storage class of the object

Key

string

Object name

LastModified

string

Time when the last modification was made to the object

Owner

associative array

Object owner

  

DisplayName

string

Name of the object owner

ID

string

ID of the domain to which the object owner belongs

CommonPrefixes

indexed array

List of object name prefixes grouped according to the Delimiter parameter (if specified)

  

Prefix

string

Object name prefix grouped according to the Delimiter parameter

Sample Code

try{
       $resp = $obsClient -> listObjects([
              'Bucket' => 'bucketname',
              'Prefix' => 'prefix',
              'MaxKeys' => 100
       ]);
       printf("RequestId:%s\n", $resp['RequestId']);
       foreach ($resp['Contents'] as $index => $content){
              printf("Contents[%d]\n", $index + 1);
              printf("ETag:%s\n", $content['ETag']);
              printf("Size:%s\n", $content['Size']);
              printf("StorageClass:%s\n", $content['StorageClass']);
              printf("Key:%s\n", $content['Key']);
              printf("LastModified:%s\n", $content['LastModified']);
              printf("Owner[ID]:%s\n", $content['Owner']['ID']);
              printf("Owner[DisplayName]:%s\n", $content['Owner']['DisplayName']);
       }
}catch (Obs\Common\ObsException $obsException){
       printf("ExceptionCode:%s\n", $obsException->getExceptionCode());              
       printf("ExceptionMessage:%s\n", $obsException->getExceptionMessage());
}