DeleteImage - - Alibaba Cloud ドキュメントセンター

操作説明

この操作を呼び出してイメージを削除すると、ソースファイルは完全に削除され、回復できません。この操作を呼び出す際はご注意ください。
一部のイメージが Alibaba Cloud CDN の POP (Points of Presence) にキャッシュされている場合、イメージ URL はすぐには無効になりません。
この操作を呼び出して、アップロードされたイメージとビデオスナップショットを削除できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:DeleteImage

delete

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DeleteImageType	string	必須	イメージを削除するために使用されるメソッド。有効な値： ImageURL：URL に基づいてイメージを削除します。 ImageId：イメージ ID に基づいてイメージを削除します。 VideoId：ビデオ ID に基づいてビデオに関連付けられているイメージを削除します。	VideoId
ImageURLs	string	任意	イメージの URL。 CreateUploadImage 操作の応答から `ImageURL` の値を取得できます。最大 20 個の URL を指定でき、コンマ (,) で区切ります。説明このパラメーターは、DeleteImageType を ImageURL に設定した場合にのみ有効になり、必須です。	https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png
ImageIds	string	任意	イメージの ID。最大 20 個のイメージ ID を指定でき、コンマ (,) で区切ります。次のいずれかの方法でイメージ ID を取得できます。 ApsaraVideo VOD コンソールにログインします。左側のナビゲーションウィンドウで、[メディアファイル] > [イメージ] を選択して、イメージ ID を表示します。アップロード認証情報と URL を取得するために呼び出す CreateUploadImage 操作の応答からイメージ ID を取得します。イメージをクエリするために呼び出す SearchMedia 操作の応答からイメージ ID を取得します。説明このパラメーターは、DeleteImageType を ImageId に設定した場合にのみ有効になり、必須です。	bbc65bba53fed90de118a7849**,594228cdd14b4d069fc17a8c4a**
VideoId	string	任意	ビデオの ID。ID は 1 つだけ指定できます。次のいずれかの方法で ID を取得できます。 ApsaraVideo VOD コンソールにログインします。左側のナビゲーションウィンドウで、[メディアファイル] > [オーディオ/ビデオ] を選択します。[ビデオとオーディオ] ページで、メディアファイルの ID を表示します。アップロード認証情報と URL を取得するために呼び出す CreateUploadVideo 操作の応答からビデオ ID を取得します。ビデオをクエリするために呼び出す SearchMedia 操作の応答からビデオ ID を取得します。説明このパラメーターは、DeleteImageType を VideoId に設定した場合にのみ有効になり、必須です。	eb1861d2c9a8842340e989dd56****
ImageType	string	任意	削除するイメージのタイプ。イメージはビデオに関連付けられています。有効な値： CoverSnapshot：サムネイルスナップショット。 NormalSnapshot：一般スナップショット。 SpriteSnapshot：スプライトスナップショット。 SpriteOriginSnapshot：スプライトソーススナップショット。 All：上記のすべてのタイプのイメージ。このパラメーターには `All` 以外の複数のタイプを指定できます。複数のタイプはコンマ (,) で区切ります。説明このパラメーターは、DeleteImageType を VideoId に設定した場合にのみ有効になり、必須です。	All

レスポンスフィールド

フィールド	型	説明	例
	object	返される結果。
RequestId	string	リクエストの ID。	25818875-5F78-4AF6-D7393642CA58****

例

成功レスポンス

JSONJSON

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。