GetImageInfo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the basic information and access URL of an image based on the image ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	Yes	The ID of the image. You can use one of the following methods to obtain the ID: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Image. On the Image page, view the image ID. Obtain the image ID from the response to the CreateUploadImage operation that you call to obtain the upload URL and credential. Obtain the image ID from the response to the SearchMedia operation that you call to query the image.	3e34733b40b9a96ccf5c1ff6f69****
AuthTimeout	long	No	The time when the image URL expires. Unit: seconds. If you set OutputType to cdn: This parameter takes effect only if URL authentication is enabled. Otherwise, the image URL does not expire. Minimum value: 1. Maximum value: unlimited. Default value: If you leave this parameter empty, the default validity period that is specified in URL signing is used. If you set OutputType to oss: This parameter takes effect only when the ACL of the Object Storage Service (OSS) bucket is private. Otherwise, the image URL does not expire. Minimum value: 1. If you store the image in the VOD bucket, the maximum value of this parameter is 2592000 (30 days). If you store the image in an OSS bucket, the maximum value of this parameter is 129600 (36 hours). The maximum value is limited to reduce security risks of the origin. Default value: 3600.	3600
OutputType	string	No	The type of the output image URL. Valid values: oss: OSS URL cdn: CDN URL	cdn

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	AB99D4DF-FAFA-49DC-9C548C1E261E****
ImageInfo	object	The information about the image.
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 bucket in which the image is stored.	outin-****..oss-cn-shanghai.aliyuncs.com
Status	string	The status of the image. Valid values: Uploading: The image is being uploaded. This is the initial status. Normal: The image is uploaded. UploadFail: The image fails to be uploaded.	Uploading
CateId	long	The ID of the category.	254766071
Tags	string	The tags of the image. Multiple tags are separated by commas (,).	tag1,tag2,tag3
ImageType	string	The type of the image. Valid values: CoverSnapshot: thumbnail snapshot. NormalSnapshot: normal snapshot. SpriteSnapshot: sprite snapshot. SpriteOriginSnapshot: sprite source snapshot. All: images of all the preceding types. Multiple types other than All can return for this parameter. Multiple types are separated by commas (,).	NormalSnapshot
CateName	string	The name of the category.	test name
Description	string	The description of the image.	test description
AppId	string	The ID of the application.	app-****
URL	string	The image URL. If a domain name for CDN is specified, a CDN URL is returned. Otherwise, an OSS URL is returned.	http://example.aliyundoc.com/image/default/**.gif?auth_key=**
Title	string	The title of the image.	this is a sample
ImageId	string	The ID of the image.	bbc65bba53f9*****ed90de118a7849
Mezzanine	object	The source information about 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

Sample success responses

JSONformat

{
  "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": "NormalSnapshot",
    "CateName": "test name",
    "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

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
NoSuchResource	The specified resource does not exist.	404	The error message returned because the image does not exist.