All Products
Search
Document Center

Image Search:DeleteImage

Last Updated:Aug 21, 2023

Removes images from an Image Search instance.

Usage notes

You can call this operation to remove images from an Image Search instance.

Note
  • Even if the specified image does not exist in the instance, a success response is returned. Therefore, you cannot determine whether the image exists in the instance based on the response.

  • If you want to obtain more information about the service and technical support, click pre-sales online consulting or join the DingTalk group (ID 35035130).

QPS limits

By default, the concurrency limit for this operation is 20. This means that the system can process up to 20 requests of removing images every second.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DeleteImage

The operation that you want to perform. Set the value to DeleteImage.

InstanceName

String

Yes

demoinstance1

The name of the Image Search instance. The name can be up to 20 characters in length.

If an Image Search instance is purchased, you can log on to the Image Search console to view the instance.

If no Image Search instance is purchased, you must purchase an instance. For more information, see Activate Image Search and Create an instance.

Note

The instance name is not the instance ID. The instance name must be unique within a region.

ProductId

String

Yes

2092061_1

The product ID.

Note

A product may have multiple images.

PicName

String

No

2092061_1.jpg

The name of the image.

  • If you do not specify this parameter, the system removes all the images that are related to the product ID specified by ProductId.

  • If you specify this parameter, the system removes only the image that is specified by ProductId and PicName.

Response parameters

Parameter

Type

Example

Description

Message

String

success

The returned message.

RequestId

String

0703956F-9BCC-48FA-99F7-96C0BF449C69

The request ID.

Code

Integer

0

The response code.

  • A value of 0 indicates that the request was successful.

  • Values other than 0 indicate that the request failed.

Success

Boolean

true

Indicates whether the request was successful.

Data

Object

The information about the removed images.

PicNames

Array of String

xxx.jpg

The names of the removed images.

Examples

Sample requests

{
        "InstanceName": "demoinstance",
        "PicName": "test",
        "ProductId": "test"
    }

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "1F59AE0A-8B57-14A6-BCE8-E2592CA5FA0F",
  "Data" : {
    "PicNames" : [ "5555.jpg" ]
  },
  "Code" : 0,
  "Success" : true
}

Error codes

HTTP status code

Error code

Error message

Description

400

BadRequest

The request has invalid parameters.

One or more parameters are invalid.

400

InvalidInstance

The specified instance name is invalid.

The instance name is invalid.

400

NoCaretSeperator

The body content is missing the ^ separator.

Specific symbols are missing in the request body.

400

EmptyMeta

The body content has an empty meta field.

The request body contains empty meta parameters.

400

InvalidMetaItem

The meta field is invalid.

A meta parameter is set to an invalid value.

400

InvalidPicList

The specified pic_list parameter is invalid.

The pic_list parameter is set to an invalid value.

400

NoSpecifiedPic

The content of an image is not specified in the HTTP POST body.

No image is specified.

400

InvalidCategory

The specified category is invalid.

The category ID is invalid.

400

OverflowMaxResultNum

The specified number of total results exceeds the maximum of 500.

The specified total number of entries to return exceeds the upper limit, which is 500.

400

OverflowMaxReturnNum

The specified number of results for each request exceeds the maximum of 100.

The specified number of entries to return for a single request exceeds the upper limit, which is 100.

400

InvalidIntAttr

The specified int_attr field is invalid.

The IntAttr parameter is set to an invalid value.

400

UnsupportedPicFormat

The specified image format is invalid.

The image format is invalid.

400

InvalidFilterClause

The specified filtering condition is invalid.

The filter condition is invalid.

400

InstanceOverQuota

The number of items exceeds the limit.

The number of images in the instance exceeds the upper limit.

400

IncorrectOrientation

The image contains incorrect rotation flags in the meta data.

The image carries rotation settings. Rotation settings are not supported.

400

UnsupportedPicPixels

The specified pixels is not supported.

The specified image pixel value is not supported.

403

NoPermission

You are not authorized to perform this operation.

You do not have the required permissions. Ask the administrator to grant you the permissions.

403

DeniedRequest

Your request was denied due to instance flow control.

Your request was denied due to throttling.

500

NetworkException

A network error occurred.

A network error has occurred.

500

UnsupportedInstanceType

The instance type is not supported.

The instance type is not supported.

500

UnsupportedOperationType

The specified action is not supported.

The specified operation is not supported.

500

AccessEngineFailed

An error occurred while accessing the search engine.

An error has occurred in the search engine.

500

InternalOssError

An internal OAS error occurred.

An internal algorithm error has occurred.

500

InternalSwiftError

An internal SWIFT error occurred.

An internal message queue error has occurred.

500

InternalTableStoreError

An internal Table Store error occurred.

An internal storage error has occurred.

For a list of error codes, see Service error codes.

Error codes

For a list of error codes, see Service error codes.