本接口用于删除图像搜索实例中的图片信息。

说明 如果指定图片在图像搜索实例中不存在,该接口依然会返回成功。不能用返回结果来判断图片是否存在。

请求路径

协议 URL 方法 参数
HTTPS ${HOST}/v2/image/delete POST JSON

${HOST}请参见请求结构

请求参数

名称 类型 是否必须 描述
InstanceName String 图像搜索实例名称。
ProductId String 商品ID。
PicName String 图片名称。
  • 如果不指定本参数,则删除ProductId下所有图片。
  • 如果指定本参数,则删除ProductId+PicName指定的图片。

返回参数

名称 类型 示例 描述
Success Boolean true 请求是否成功。
RequestId String 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1 请求的ID。
Code Integer 0 错误码。0表示成功;非0表示失败。
Message String success 错误信息。

示例

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

错误码

请参见错误码