ListObjects

get

/n/{namespace_name}/b/{bucket_name}/o

List the objects in a bucket. By default, ListObjects returns object names only. See the fields parameter for other fields that you can optionally include in ListObjects response. ListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith' value with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end' parameters. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see "Managing Policies" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-manage-policies.html).

Request

Supported Media Types
Path Parameters
Query Parameters
  • When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that '/' is the only supported delimiter character.
  • Returns object names which are lexicographically strictly less than this parameter.
  • Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. Example: 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'
    Allowed Values: [ "name", "size", "etag", "timeCreated", "md5", "archivalState", "timeModified", "storageTier", "archivalState" ]
  • Minimum Value: 1
    Maximum Value: 1000
    For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.
    Default Value: 100
  • The string to use for matching against the start of object names in a list query.
  • Returns object names which are lexicographically greater than or equal to this parameter.
  • Returns object names which are lexicographically strictly greater than this parameter.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

List of object summaries, including optional prefixes and, in a truncated response, the name of the object to start next page of results.
Headers
  • Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID.
Body ()
Root Schema : ListObjects
Type: object
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator.
Show Source
Nested Schema : objects
Type: array
An array of object summaries.
Show Source
  • ObjectSummary
    To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator.
Nested Schema : prefixes
Type: array
Prefixes that are common to the results returned by the request if the request specified a delimiter.
Show Source
Nested Schema : ObjectSummary
Type: object
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator.
Show Source
Example Response (application-json)
{   "objects": [     {       "name": "1MB.data"     }   ] } 

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

408 Response

Request Timeout
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

Default Response

A description of an error that occurred.
Headers
  • Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.
Back to Top