edit-icon download-icon

画像の削除

最終更新日: May 24, 2019

説明

このインターフェイスは、Image Search インスタンス内の指定した画像を削除するのに使用します。

説明: 指定した画像が Image Search インスタンス内に存在しない場合でも、成功を返します。結果から画像の存在有無を判断することはできません。

リクエストパス

プロトコル URL 方法 パラメーター
HTTPS ${HOST}/v2/image/delete POST JSON

${HOST} はリクエスト構造をご参照ください。

リクエストパラメーター

名前 必須 説明
InstanceName String はい Image Search インスタンス名
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 エラーメッセージ

リクエスト例

  1. URL: ${HOST}/v2/image/delete
  2. POST Body:
  3. {
  4. "InstanceName": "demoinstance",
  5. "PicName": "test",
  6. "ProductId": "test",
  7. }

リクエスト結果例

  1. {
  2. "Message": "success",
  3. "RequestId": "05BAAD52-4E88-4DAA-918D-13064C0D7A25",
  4. "Success": true,
  5. "Code": 0
  6. }

エラーコード

エラーコードをご参照ください。