调用GetImageInfo通过图片ID获取图片的基本信息,包括图片标题、类型、创建时间、标签等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetImageInfo

系统规定参数。取值:GetImageInfo

ImageId String 3e34733b40b*****9a96ccf5c1ff6f69

图片ID。

AuthTimeout Long 3600

图片地址过期时间。单位:秒。

说明
  • 当OutputType取值为CDN时:
    • 只有开启了URL鉴权图片地址才会定期失效,否则会永久有效。
    • 最小值:1
    • 最大值:无限制。
    • 默认值:未设置时,取值为URL鉴权中设置的默认有效时长。
  • 当OutputType取值为OSS时:
    • 只有存储权限为私有,播放地址才会定期失效,否则会永久有效。
    • 最小值:1
    • 最大值:为降低源站安全风险,最大值为2592000(即30天)。
    • 默认值:未设置时,取值为3600
OutputType String cdn

输出地址类型。取值范围 :

  • oss:回源地址。
  • cdn(默认):加速地址。

返回数据

名称 类型 示例值 描述
ImageInfo Struct

图片信息。

AppId String app-****

应用ID。

CateId Long 254766071

分类ID。

CateName String 测试

分类名称。

CreationTime String 2018-11-21T02:37:23Z

图片创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Description String 测试描述

描述。

ImageId String bbc65bba53f9*****ed90de118a7849

图片ID。

ImageType String default

图片类型。取值:

  • CoverSnapshot:封面截图。
  • NormalSnapshot:普通截图。
  • SpriteSnapshot:雪碧截图。
  • SpriteOriginSnapshot:雪碧图原始图。
  • All(以上多种类型的图片):非All时支持多个类型,使用英文逗号(,)分隔传入。
Mezzanine Struct

图片源信息。

FileSize String 8932

文件大小。单位:字节。

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

图片OSS URL。

Height Integer 200

图片高度。单位:像素。

OriginalFileName String ****.gif

上传文件名称。

Width Integer 200

图片宽度。单位:像素。

Status String Uploading

图片状态。取值:

  • Uploading:初始状态,表示图片正在上传。
  • Normal:图片上传成功。
  • UploadFail:图片上传失败。
StorageLocation String sample.oss-cn-shanghai.aliyuncs.com

文件存储区域。

Tags String tag1,tag2,tag3

图片标签。多个使用英文逗号(,)隔开。

Title String this is a sample

图片标题。

URL String http://sample.com/image/default/****.gif?auth_key=****

图片URL(如果配置了CDN域名则为CDN地址,否则为OSS地址)。

RequestId String AB99D4DF-FAFA-49*****DC-9C548C1E261E

请求ID。

示例

请求示例

https://vod.aliyuncs.com/?Action=GetImageInfo
&ImageId=3e34733b40b*****9a96ccf5c1ff6f69
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

NoSuchResource

The specified resource does not exist.

404

图片不存在。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: