All Products
Search

This Product

    ApsaraVideo VOD:GetImageInfo

    Document Center

    ApsaraVideo VOD:GetImageInfo

    Last Updated:Jul 21, 2026

    Retrieves the basic information and access URL of an image by image ID after the image is uploaded to ApsaraVideo VOD.

    Operation description

    This operation only supports querying information about images uploaded to ApsaraVideo VOD. To query information about snapshots generated from video snapshots, call the ListSnapshots operation.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    vod:GetImageInfo

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ImageId

    string

    Yes

    The image ID. You can obtain the image ID by using one of the following methods:

    • Log on to the ApsaraVideo VOD console and choose Media Files > Images to view the ID.

    • Obtain the ID from the response of the CreateUploadImage operation when you retrieve the upload URL and credential.

    • Obtain the ID from the response of the SearchMedia operation when you query images.

    3e34733b40b9a96ccf5c1ff6f69****
    AuthTimeout

    integer

    No

    The validity period of the image access URL. Unit: seconds.

    • If OutputType is set to cdn:

      • The image URL expires only if URL signing is enabled. Otherwise, the URL is permanently valid.

      • Minimum value: 1.

      • Maximum value: unlimited.

      • Default value: If this parameter is not specified, the default validity period specified in URL signing is used.

    • If OutputType is set to oss:

      • The playback URL expires only if the storage permission is set to private. Otherwise, the URL is permanently valid.

      • Minimum value: 1.

      • Maximum value: To reduce security risks to the origin server, the maximum value is 2592000 (30 days) if the image is stored in a VOD system bucket, and 129600 (36 hours) if the image is stored in your own OSS bucket.

      • Default value: If this parameter is not specified, the value is 3600.

    3600
    OutputType

    string

    No

    The type of the image access URL to return. Valid values:

    • oss: the origin URL.

    • cdn (default): the accelerated URL.

    cdn

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    object

    The image information.

    CreationTime

    string

    The time when the image was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

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

    string

    The storage address of the image file.

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

    string

    The image status. Valid values:

    • Uploading: The image is being uploaded. This is the initial status.

    • Normal: The image is uploaded.

    • UploadFail: The image failed to be uploaded.

    Uploading
    CateId

    integer

    The category ID.

    254766071
    Tags

    string

    The image tags. Multiple tags are separated by commas (,).

    tag1,tag2,tag3
    ImageType

    string

    The image type. Valid values:

    • default: regular image.

    • cover: video thumbnail.

    default
    CateName

    string

    The category name.

    Test
    Description

    string

    The image description.

    Test description
    AppId

    string

    The application ID.

    app-****
    URL

    string

    The image access URL. If a CDN domain name is configured, the CDN URL is returned. Otherwise, the OSS URL is returned.

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

    string

    The image title.

    this is a sample
    ImageId

    string

    The image ID.

    bbc65bba53f9*****ed90de118a7849
    Mezzanine

    object

    The mezzanine information of the image.

    FileURL

    string

    The OSS URL of the image file.

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

    string

    The URL of the source file.

    ****.gif
    Width

    integer

    The width of the image. Unit: pixels.

    200
    Height

    integer

    The height of the image. Unit: pixels.

    200
    FileSize

    string

    The size of the image. Unit: bytes.

    8932

    Examples

    Success response

    JSON format

    {
  "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": "Test",
    "Description": "Test 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"
    }
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.