Deletes image data from an Image Search instance.

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

Request URL

Protocol URL Method Parameter
HTTPS ${HOST}/v2/image/delete POST JSON

For more information about ${HOST}, see Request syntax.

Request parameters

Parameter Type Required Description
InstanceName String Yes The name of the Image Search instance.
ProductId String Yes The ID of the product.
PicName String No The name of the image.
  • If this parameter is not specified, the system deletes all the images that correspond to the specified ProductId parameter.
  • If this parameter is specified, the system deletes only the image that is specified by the ProductId and PicName parameters.

Response parameters

Parameter Type Example Description
Success Boolean true Indicates whether the request is successful.
RequestId String 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1 The ID of the request.
Code Integer 0 The error code. The value 0 indicates a request success. A value that is not 0 indicates a request failure.
Message String success The returned message.

Examples

  • Sample requests
    URL: ${HOST}/v2/image/delete
    POST Body:
     {
            "InstanceName": "demoinstance",
            "PicName": "test",
            "ProductId": "test",
        }
  • Sample responses
    {
        "Message": "success",
        "RequestId": "05BAAD52-4E88-4DAA-918D-13064C0D7A25",
        "Success": true,
        "Code": 0
    }

Error codes

For more information, see Error codes.