List Objects
GET {{baseUrl}}/n/:namespaceName/b/:bucketName/o?limit=154
Lists 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 Getting Started with Policies.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
prefix | string | The string to use for matching against the start of object names in a list query. | |
start | string | Object names returned by a list query must be greater or equal to this parameter. | |
end | string | Object names returned by a list query must be strictly less than this parameter. | |
limit | number | For list pagination. The maximum number of results per page, or items to return in a paginated | |
| "List" call. For important details about how pagination works, see | |||
| List Pagination. | |||
delimiter | string | 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 only '/' is a supported delimiter character at this time. | |||
fields | string | 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. | |||
| For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'. | |||
startAfter | string | Object names returned by a list query must be greater than this parameter. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-client-request-id | string | The client request ID for tracing. | |
Accept | string |
RESPONSES
status: OK
{"objects":[{"name":"eu ex voluptate","archivalState":"Restoring","etag":"ea in velit","md5":"sint","size":-69689043,"storageTier":"InfrequentAccess","timeCreated":"1945-03-21T12:17:56.119Z","timeModified":"1976-06-03T15:13:07.963Z"},{"name":"quis ullamco ex laboris","archivalState":"Archived","etag":"Excepteur o","md5":"sunt","size":64871878,"storageTier":"InfrequentAccess","timeCreated":"1945-11-09T10:42:05.717Z","timeModified":"1970-11-08T11:18:02.424Z"}],"nextStartWith":"dolor volupta","prefixes":["Excepteur","cupidatat nostrud"]}