Querying Objects in a Bucket
Function
Queries objects in a bucket.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0-ext/{project_id}/objects
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID . |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
bucket |
Yes |
String |
Specifies the bucket name. |
prefix |
No |
String |
Queries the prefix of an object. |
type |
No |
String |
Queries the file type of an object. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory when AK/SK-based authentication is used. |
X-Project_Id |
No |
String |
Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
objects |
Array of ObsObject objects |
Returns the OBS object group. |
Parameter |
Type |
Description |
---|---|---|
file_name |
String |
Object key |
size |
Long |
File size |
last_modified |
String |
Time when the file is last modified |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
GET https://{endpoint}/v1/{project_id}/objects
Example Responses
Status code: 400
Objects in the bucket cannot be queried.
{ "error_code" : "MPC.10209", "error_msg" : "Invalid input or output OBS path." }
Status Codes
Status Code |
Description |
---|---|
200 |
Objects in the bucket have been queried. |
400 |
Objects in the bucket cannot be queried. |
Error Codes
See Error Codes.
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