-
API Reference
- Overview
- Initialization
- Predefined Constants
-
Bucket-Related APIs
- PUT Bucket
- GET Buckets
- HEAD Bucket
- DELETE Bucket
- GET Objects
- GET Object versions
- List Multipart uploads
- Obtain Bucket Metadata
- GET Bucket location
- GET Bucket storageinfo
- PUT Bucket quota
- GET Bucket quota
- Set Bucket storagePolicy
- GET Bucket storagePolicy
- PUT Bucket acl
- GET Bucket acl
- PUT Bucket logging
- GET Bucket logging
- PUT Bucket policy
- GET Bucket policy
- DELETE Bucket policy
- PUT Bucket lifecycle
- GET Bucket lifecycle
- DELETE Bucket lifecycle
- PUT Bucket website
- GET Bucket website
- DELETE Bucket website
- PUT Bucket versioning
- GET Bucket versioning
- PUT Bucket cors
- GET Bucket cors
- DELETE Bucket cors
- PUT Bucket tagging
- GET Bucket tagging
- DELETE Bucket tagging
- Objects-Related APIs
- Other APIs
- Change History
- General Reference
Copied.
GET Buckets
API Description
You can use this API to obtain the bucket list. In the list, bucket names are displayed in lexicographical order.
Method Definition
1. ObsClient->listBuckets(array $parameter) 2. ObsClient->listBucketsAsync(array $parameter, callable $callback)
Request Parameter
Field |
Type |
Optional or Mandatory |
Description |
---|---|---|---|
QueryLocation |
boolean |
Optional |
Whether to query the bucket location |
Returned Result
Field |
Type |
Description |
|
---|---|---|---|
HttpStatusCode |
integer |
HTTP status code |
|
Reason |
string |
Reason description |
|
RequestId |
string |
Request ID returned by the OBS server |
|
Buckets |
indexed array |
List of buckets |
|
Name |
string |
Bucket name |
|
CreationDate |
string |
Time when the bucket is created |
|
Location |
string |
Bucket location |
|
Owner |
associative array |
Bucket owner |
|
ID |
string |
ID of the domain to which the bucket owner belongs |
Sample Code
try{ $resp = $obsClient -> listBuckets([ 'QueryLocation' => true ]); printf("RequestId:%s\n", $resp['RequestId']); printf("Owner[ID]:%s\n", $resp['Owner']['ID']); foreach ($resp['Buckets'] as $index => $bucket){ printf("Buckets[%d]\n", $index + 1); printf("Name:%s\n", $bucket['Name']); printf("CreationDate:%s\n", $bucket['CreationDate']); printf("Location:%s\n", $bucket['Location']); } }catch (Obs\Common\ObsException $obsException){ printf("ExceptionCode:%s\n", $obsException->getExceptionCode()); printf("ExceptionMessage:%s\n", $obsException->getExceptionMessage()); }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot