- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Developer Manual
- API Documentation
- Bucket Configuration
- Image Processing
- Basic Image Processing
- Scaling
- Cropping
- Rotating
- Converting Format
- Quality Change
- Gaussian Blurring
- Adjusting Brightness
- Adjusting Contrast
- Sharpening
- Image Watermarking
- Text Watermarking
- Obtaining Basic Image Information
- Obtaining Image EXIF
- Obtaining Image’s Average Hue
- Removing Image Metadata
- Quick Thumbnail Template
- Pipeline Operators
- Limiting Output Image Size
- Supported Fonts
- Image Styles
- Image Compression
- Blind Watermarking
- Persistent Image Processing
- Basic Image Processing
- AI-Based Content Recognition
- Media Processing
- Common Request Headers
- Common Response Headers
- Error Codes
- Template APIs
- Media Bucket APIs
- Queue APIs
- Task APIs
- Animated Image Task APIs
- Screenshot Task APIs
- Transcoding Task APIs
- Smart Cover Task APIs
- Concatenation Task APIs
- Multi-task APIs
- Video Montage Task APIs
- Voice Separation Task APIs
- Video Enhancement Task APIs
- SDR-to-HDR Task APIs
- Super Resolution Task APIs
- Audio/Video Segmentation Task APIs
- Media Information Query Task
- Media Screenshot API
- Media Information API
- Workflow APIs
- Private M3U8 API
- Callback Content
- Error Codes
- SDK Documentation
- FAQs
- Contact Us
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Developer Manual
- API Documentation
- Bucket Configuration
- Image Processing
- Basic Image Processing
- Scaling
- Cropping
- Rotating
- Converting Format
- Quality Change
- Gaussian Blurring
- Adjusting Brightness
- Adjusting Contrast
- Sharpening
- Image Watermarking
- Text Watermarking
- Obtaining Basic Image Information
- Obtaining Image EXIF
- Obtaining Image’s Average Hue
- Removing Image Metadata
- Quick Thumbnail Template
- Pipeline Operators
- Limiting Output Image Size
- Supported Fonts
- Image Styles
- Image Compression
- Blind Watermarking
- Persistent Image Processing
- Basic Image Processing
- AI-Based Content Recognition
- Media Processing
- Common Request Headers
- Common Response Headers
- Error Codes
- Template APIs
- Media Bucket APIs
- Queue APIs
- Task APIs
- Animated Image Task APIs
- Screenshot Task APIs
- Transcoding Task APIs
- Smart Cover Task APIs
- Concatenation Task APIs
- Multi-task APIs
- Video Montage Task APIs
- Voice Separation Task APIs
- Video Enhancement Task APIs
- SDR-to-HDR Task APIs
- Super Resolution Task APIs
- Audio/Video Segmentation Task APIs
- Media Information Query Task
- Media Screenshot API
- Media Information API
- Workflow APIs
- Private M3U8 API
- Callback Content
- Error Codes
- SDK Documentation
- FAQs
- Contact Us
Overview
This API is used to enable the search by image feature for a bucket.
Request
Sample request
POST /ImageSearchBucket HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Note：Authorization: Auth String (For more information, please see Request Signature.)
Request parameters
This API has no request parameter.
Request headers
This API only uses Common Request Headers.
Request body
This request requires the following request body:
<Request>
<MaxCapacity>10000</MaxCapacity>
<MaxQps>10</MaxQps>
</Request>
The nodes are described as follows:
| Node Name (Keyword) | Parent Node | Description | Type | Required |
|---|---|---|---|---|
| Request | None | Request container | Container | Yes |
Request has the following sub-nodes:
| Node Name (Keyword) | Parent Node | Description | Type | Required |
|---|---|---|---|---|
| MaxCapacity | Request | Maximum capacity of the image library | Int | Yes |
| MaxQps | Request | Maximum QPS of the image library. Default value: 10 |
Int | No |
Response
Response headers
This API only returns Common Response Headers.
Response body
This response has no response body.
Error codes
This API returns common error responses and error codes. For more information, please see Error Codes.
Samples
Request
POST /ImageSearchBucket HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKID8A0fBVtYFrNm02oY1g1JQQF0c3JO****&q-sign-time=1558699190;1558706390&q-key-time=1558699190;1558706390&q-header-list=date;host&q-url-param-list=&q-signature=89fa1f6a56c34e460f3db4d65f928eaf034a****
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Content-Length: 50
Content-Type: application/xml
<Request>
<MaxCapacity>10000</MaxCapacity>
<MaxQps>10</MaxQps>
</Request>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 0
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
Yes
No
Was this page helpful?