Image Search インスタンスから画像データを削除します。

注 指定された画像がインスタンスに存在しない場合でも、成功応答が返されます。 したがって、画像がインスタンスに存在するかどうかは、応答に基づいて判断することはできません。

リクエスト URL

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

${HOST} の詳細については、「リクエストの構文」をご参照ください。

リクエストパラメーター

パラメーター タイプ 必須 / 任意 説明
InstanceName String 必須 Image Search インスタンスの名前。
ProductId String 必須 プロダクトの ID
PicName String 任意 イメージの ID。
  • このパラメーターが指定されていない場合、システムは指定された 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
}

エラーコード

詳細については、「エラーコード」をご参照ください。