ListBuckets

get

/n/{namespace_name}/b

Get a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket and does not contain fields such as user-defined metadata. ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned opc-next-page value with the page request parameter. 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
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment.
  • Collection Format: csv
    Bucket summary in list of buckets includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated', and 'etag' fields. This parameter can also include 'tags' (freeformTags and definedTags). The only supported value of this parameter is 'tags'. Example tags.
    • Allowed Values: [ "tags" ]
  • 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
  • Minimum Length: 1
    Maximum Length: 512
    For list pagination. The value of the opc-next-page response header from the previous List call.
    Default Value: 0
  • The optional field to sort the results by.
    Allowed Values: [ "TIMECREATED", "NAME" ]
  • The sort order to use, either ascending (ASC) or descending (DESC).
    Default Value: ASC
    Allowed Values: [ "ASC", "DESC" ]
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

A page of BucketSummary objects.
Headers
  • Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
  • For paginating a list of buckets. In the GET request, set the limit to the number of buckets items that you want returned in the response. If the `opc-next-page` header appears in the response, then this is a partial list and there are additional buckets to get. Include the header's value as the `page` parameter in the subsequent GET request to get the next batch of buckets. Repeat this process to retrieve the entire list of buckets. By default, the page limit is set to 25 buckets per page, but you can specify a value from 1 to 1000. For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID.
Body ()
Root Schema : schema
Type: array
Show Source
  • BucketSummary
    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 : BucketSummary
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 : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.
Example Response (application-json)
[   {     "namespace": "ansh8lvru1zp",     "name": "MyBucket_1",     "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment1ID",     "createdBy": "ocid1.user.oc1..exampleuniqueuserID",     "timeCreated": "2016-08-09T01:11:38.639Z",     "etag": "dc450b1e-a22c-479a-aae2-a5903e519661"   },   {     "namespace": "ansh8lvru1zp",     "name": "MyBucket_2",     "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment2ID",     "createdBy": "ocid1.user.oc1..exampleuniqueuser2ID",     "timeCreated": "2016-08-09T00:41:50.236Z",     "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef94"   },   {     "namespace": "ansh8lvru1zp",     "name": "MyBucket_3",     "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment3ID",     "createdBy": "ocid1.user.oc1..exampleuniqueuserID",     "timeCreated": "2016-08-08T21:18:37.448Z",     "etag": "ed042fb0-a22f-48cc-a6d3-5590ee0bd0d2"   },   {     "namespace": "ansh8lvru1zp",     "name": "MyBucket_4",     "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment4ID",     "createdBy": "ocid1.user.oc1..exampleuniqueuserID",     "timeCreated": "2017-01-20T00:25:55.758Z",     "etag": "21edf865-d3d9-424f-8218-37188e803db8"   },   {     "namespace": "ansh8lvru1zp",     "name": "MyBucket_5",     "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment5ID",     "createdBy": "ocid1.user.oc1..exampleuniqueuserID",     "timeCreated": "2017-01-20T19:12:41.886Z",     "etag": "30d83c79-dd32-4c07-ace9-9240ed7083fd"   } ] 

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