Jump to

• Request
• Response

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

• application/json

Path Parameters

• bucketName(required): string
  Minimum Length: 1

  Pattern: [A-Za-z0-9\\-_\\.]+

  The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
• namespaceName(required): string
  Minimum Length: 1

  Pattern: [A-Za-z][A-Za-z0-9\\-_\\.]+

  The Object Storage namespace used for the request.

Query Parameters

• 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 '/' is the only supported delimiter character.
• end: string
  Object names returned by a list query must be strictly less than this parameter.
• 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. Example: 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'

  Allowed Values: [ "name", "size", "etag", "timeCreated", "md5", "archivalState", "timeModified", "storageTier", "archivalState" ]
• limit: integer
  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
• 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.
• startAfter: string
  Object names returned by a list query must be greater than this parameter.

Header Parameters

• opc-client-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

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

• opc-client-request-id: string
  Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

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

• nextStartWith: string
  The name of the object to use in the start parameter to obtain the next page of a truncated ListObjects response. Avoid entering confidential information. Example: test/object1.log
• objects(required): array objects
  An array of object summaries.
• prefixes: array prefixes
  Prefixes that are common to the results returned by the request if the request specified a delimiter.

{
    "description":"To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator.",
    "required":[
        "objects"
    ],
    "properties":{
        "objects":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObjectSummary"
            },
            "description":"An array of object summaries. "
        },
        "prefixes":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Prefixes that are common to the results returned by the request if the request specified a delimiter. "
        },
        "nextStartWith":{
            "type":"string",
            "description":"The name of the object to use in the start parameter to obtain the next page of a truncated ListObjects response. Avoid entering confidential information. Example: test/object1.log "
        }
    },
    "type":"object"
}

Nested Schema : objects

Type: array

An array of object summaries.

Show Source

• Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObjectSummary"
    },
    "description":"An array of object summaries. "
}

Nested Schema : prefixes

Type: array

Prefixes that are common to the results returned by the request if the request specified a delimiter.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Prefixes that are common to the results returned by the request if the request specified a delimiter. "
}

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

• archivalState: string
  Allowed Values: [ "Archived", "Restoring", "Restored", "Available" ]

  Archival state of an object. This field is set only for objects in Archive tier.
• etag: string
  The current entity tag (ETag) for the object.
• md5: string
  Base64-encoded MD5 hash of the object data.
• name(required): string
  The name of the object. Avoid entering confidential information. Example: test/object1.log
• queryState: string
  Allowed Values: [ "NotQueryable", "MovingToQueryTier", "Queryable" ]

  Query state of an object. This field is set only for objects in Query tier.
• size: integer(int64)
  Size of the object in bytes.
• storageTier: string
  Allowed Values: [ "Standard", "InfrequentAccess", "Archive", "Query" ]

  The storage tier that the object is stored in.
• timeCreated: string(date-time)
  The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
• timeModified: string(date-time)
  The date and time the object was modified, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29.
• versionId: string
  The current version id for the object.

{
    "description":"To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the object. Avoid entering confidential information. Example: test/object1.log "
        },
        "size":{
            "type":"integer",
            "format":"int64",
            "description":"Size of the object in bytes."
        },
        "md5":{
            "type":"string",
            "description":"Base64-encoded MD5 hash of the object data."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29)."
        },
        "etag":{
            "type":"string",
            "description":"The current entity tag (ETag) for the object."
        },
        "storageTier":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/StorageTier",
            "enum":[
                "Standard",
                "InfrequentAccess",
                "Archive",
                "Query"
            ],
            "description":"The storage tier that the object is stored in."
        },
        "archivalState":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ArchivalState",
            "enum":[
                "Archived",
                "Restoring",
                "Restored",
                "Available"
            ],
            "description":"Archival state of an object. This field is set only for objects in Archive tier."
        },
        "queryState":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/QueryState",
            "enum":[
                "NotQueryable",
                "MovingToQueryTier",
                "Queryable"
            ],
            "description":"Query state of an object. This field is set only for objects in Query tier."
        },
        "timeModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the object was modified, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29."
        },
        "versionId":{
            "type":"string",
            "description":"The current version id for the object."
        }
    },
    "type":"object"
}

Example Response (application-json)

{   "objects": [     {       "name": "1MB.data"     }   ] } 

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

408 Response

Request Timeout

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top