edit-icon download-icon

Delete Images

Last Updated: Aug 02, 2018

Description

This API is used to remove images from a specific Image Search instance. To call this API, you must specify an instance by setting the instanceName parameter and construct the content of the POST body with the relevant parameters.

Request Path

/item/delete

Request Parameters

URL parameters

Name Data type Required Description
instanceName String Yes Name of the instance from which the images will be removed.

Body Parameters

Name Data type Required Description
item_id String Yes ID of the image.
pic_list List No Image name list. If you do not specify any image names, the system removes all images in the item_id path.

Body Structure

For information about the body structure, see the Add Images operation.

Response Parameters

Name Data type Description
Success Boolean Whether or not the request is successful.
RequestId String ID of the request.
Code int Error code. If the code is 0, the request is successful. If the code is not 0, the request is failed.
Message String Error information.

Response Structure

  1. {
  2. "Message":"success",
  3. "RequestId":"73B5133C-84EE-4F0A-B972-23CCCBFB7CD5",
  4. "Success":true,
  5. "Code":0
  6. }

Example

This example shows how to remove shoes1.jpg and shoes2.jpg with image ID 1000 from instance goodssearch. The request is as follows:

  1. URL: /item/delete?instaneName=goodssearch
  2. POST Body:
  3. item_id,0,4#pic_list,4,37^1000c2hvZXMxLmpwZw==,c2hvZXMyLmpwZw==
  4. -- c2hvZXMyLmpwZw== represents the Base64 encoded image name shoes1.jpg and c2hvZXMxLmpwZw== represents the Base64 encoded image name shoes2.jpg.
Thank you! We've received your feedback.