すべてのプロダクト
Search

このプロダクト

    :GetImageInfo

    ドキュメントセンター

    :GetImageInfo

    最終更新日:Dec 15, 2025

    ApsaraVideo VOD にイメージをアップロードした後、イメージ ID に基づいて、イメージの基本情報と 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:GetImageInfo

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ImageId

    string

    必須

    イメージの ID。 次のいずれかの方法で ID を取得できます。

    • ApsaraVideo VOD コンソールにログインします。 左側のナビゲーションウィンドウで、[メディアファイル] > [イメージ] を選択します。 [イメージ] ページで、イメージ ID を表示します。

    • アップロード URL と認証情報を取得するために呼び出す CreateUploadImage 操作のレスポンスからイメージ ID を取得します。

    • イメージをクエリするために呼び出す SearchMedia 操作のレスポンスからイメージ ID を取得します。

    3e34733b40b9a96ccf5c1ff6f69****
    AuthTimeout

    integer

    任意

    イメージ URL の有効期限が切れるまでの時間。 単位：秒。

    • OutputType を `cdn` に設定した場合：

      • このパラメーターは、URL 認証が有効な場合にのみ有効になります。 それ以外の場合、イメージ URL は期限切れになりません。

      • 最小値：1。

      • 最大値：無制限。

      • デフォルト値：このパラメーターを空のままにした場合、URL 署名で指定されたデフォルトの有効期間が使用されます。

    • OutputType を `oss` に設定した場合：

      • このパラメーターは、Object Storage Service (OSS) バケットの ACL が private の場合にのみ有効になります。 それ以外の場合、イメージ URL は期限切れになりません。

      • 最小値：1。

      • イメージを VOD バケットに保存する場合、このパラメーターの最大値は 2592000 (30 日) です。 イメージを OSS バケットに保存する場合、このパラメーターの最大値は 129600 (36 時間) です。 オリジンのセキュリティリスクを軽減するため、最大値は制限されています。

      • デフォルト値：3600。

    3600
    OutputType

    string

    任意

    出力イメージ URL のタイプ。 有効な値：

    • oss：OSS URL

    • cdn：CDN URL

    cdn

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエストの ID。

    AB99D4DF-FAFA-49DC-9C548C1E261E****
    ImageInfo

    object

    イメージに関する情報。

    CreationTime

    string

    イメージが作成された時刻。 時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。 時刻は UTC で表示されます。

    2018-11-21T02:37:23Z
    StorageLocation

    string

    イメージが保存されているバケット。

    outin-****..oss-cn-shanghai.aliyuncs.com
    Status

    string

    イメージのステータス。 有効な値：

    • Uploading：イメージはアップロード中です。 これは初期ステータスです。

    • Normal：イメージはアップロード済みです。

    • UploadFail：イメージのアップロードに失敗しました。

    Uploading
    CateId

    integer

    カテゴリの ID。

    254766071
    Tags

    string

    イメージのタグ。 複数のタグはコンマ (,) で区切られます。

    tag1,tag2,tag3
    ImageType

    string

    イメージのタイプ。 有効な値：

    • CoverSnapshot：サムネイルのスナップショット。

    • NormalSnapshot：通常のスナップショット。

    • SpriteSnapshot：スプライトのスナップショット。

    • SpriteOriginSnapshot：スプライトのソーススナップショット。

    • All：前述のすべてのタイプのイメージ。 このパラメーターには、All 以外の複数のタイプを返すことができます。 複数のタイプはコンマ (,) で区切られます。

    NormalSnapshot
    CateName

    string

    カテゴリの名前。

    test name
    Description

    string

    イメージの説明。

    test description
    AppId

    string

    アプリケーションの ID。

    app-****
    URL

    string

    イメージ URL。 CDN のドメイン名が指定されている場合は CDN URL が返され、それ以外の場合は OSS URL が返されます。

    http://example.aliyundoc.com/image/default/****.gif?auth_key=****
    Title

    string

    イメージのタイトル。

    this is a sample
    ImageId

    string

    イメージの ID。

    bbc65bba53f9*****ed90de118a7849
    Mezzanine

    object

    イメージに関するソース情報。

    FileURL

    string

    イメージファイルの OSS URL。

    https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D
    OriginalFileName

    string

    ソースファイルの URL。

    ****.gif
    Width

    integer

    イメージの幅。 単位：ピクセル。

    200
    Height

    integer

    イメージの高さ。 単位：ピクセル。

    200
    FileSize

    string

    イメージのサイズ。 単位：バイト。

    8932

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "AB99D4DF-FAFA-49DC-9C548C1E261E****",
  "ImageInfo": {
    "CreationTime": "2018-11-21T02:37:23Z",
    "StorageLocation": "outin-****..oss-cn-shanghai.aliyuncs.com",
    "Status": "Uploading",
    "CateId": 254766071,
    "Tags": "tag1,tag2,tag3",
    "ImageType": "default",
    "CateName": "测试",
    "Description": "测试描述",
    "AppId": "app-****",
    "URL": "http://example.aliyundoc.com/image/default/****.gif?auth_key=****",
    "Title": "this is a sample",
    "ImageId": "bbc65bba53f9*****ed90de118a7849",
    "Mezzanine": {
      "FileURL": "https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D",
      "OriginalFileName": "****.gif",
      "Width": 200,
      "Height": 200,
      "FileSize": "8932"
    }
  }
}

    エラーコード

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

    変更履歴

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