Checking Whether a Source Bucket Has Objects with a Specified Prefix
Function
This API is used to check whether there are objects with a specified prefix in a source bucket.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/objectstorage/buckets/prefix
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The IAM token authentication. Ensure that the project ID contained in the token matches the project ID in the request URI. Minimum length: 1 character Maximum length: 16,384 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
cloud_type |
Yes |
String |
The cloud service provider. The value can be AWS, Aliyun, Qiniu, QingCloud, Tencent, Baidu, KingsoftCloud, Azure, UCloud, HuaweiCloud, Google, URLSource, or HEC. Default value: Aliyun Minimum length: 0 characters Maximum length: 100 characters |
|
ak |
No |
String |
The AK for accessing the source bucket. This parameter is mandatory when task_type is not url_list. Minimum length: 0 characters Maximum length: 100 characters |
|
sk |
No |
String |
The SK for accessing the source bucket. This parameter is mandatory when task_type is not url_list. Minimum length: 0 characters Maximum length: 100 characters |
|
json_auth_file |
No |
String |
The file used for Google Cloud Storage authentication. Minimum length: 0 characters Maximum length: 65,535 characters |
|
app_id |
No |
String |
This parameter is mandatory when cloud_type is Tencent. Minimum length: 0 characters Maximum length: 255 characters |
|
bucket_name |
Yes |
String |
The bucket name. Minimum length: 0 characters Maximum length: 100 characters |
|
file_name |
Yes |
String |
The prefix. Minimum length: 0 characters Maximum length: 1,024 characters |
|
data_center |
Yes |
String |
The region. Minimum length: 0 characters Maximum length: 100 characters |
|
security_token |
No |
String |
The security token. Minimum length: 0 characters Maximum length: 16,384 characters |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
exist |
Boolean |
Whether the prefix is found. Default value: false |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
The error message. |
|
error_code |
String |
The error code. |
Example Request
This example checks whether bucket xxx has objects with prefix xxxx.
POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/prefix
{
"cloud_type" : "HuaweiCloud",
"ak" : "xxxxak",
"sk" : "xxxxsk",
"app_id" : "apptest123",
"bucket_name" : "xxx",
"file_name" : "xxxx",
"data_center" : "cn-north-x",
"security_token" : "string"
}
Example Response
Status code: 200
The prefix was found.
{
"exist" : true
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The prefix was found. |
|
400 |
Standard error response. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
