GetImageInfo - 获取图片信息

调用GetImageInfo通过图片ID获取图片的基本信息及访问地址。

接口说明

使用说明

调用本接口通过图片ID来获取图片的基本信息,包括图片标题、类型、创建时间、标签、图片的访问地址等。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ImageIdstring

图片ID。可通过以下方式获取:

3e34733b40b9a96ccf5c1ff6f69****
AuthTimeoutLong

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

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

输出的图片访问地址的类型。取值范围 :

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求ID。

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

图片信息。

CreationTimestring

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

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

图片文件的存储地址。

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

图片状态。取值:

  • Uploading:初始状态,表示图片正在上传。
  • Normal:图片上传成功。
  • UploadFail:图片上传失败。
Uploading
CateIdLong

分类ID。

254766071
Tagsstring

图片标签。多个标签之间使用半角逗号(,)分隔。

tag1,tag2,tag3
ImageTypestring

图片类型。取值:

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

分类名称。

测试
Descriptionstring

图片描述。

测试描述
AppIdstring

应用ID。

app-****
URLstring

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

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

图片标题。

this is a sample
ImageIdstring

图片ID。

bbc65bba53f9*****ed90de118a7849
Mezzanineobject

图片源信息。

FileURLstring

图片文件的OSS地址。

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

上传的源文件名称。

****.gif
Widthinteger

图片宽度。单位:像素。

200
Heightinteger

图片高度。单位:像素。

200
FileSizestring

文件大小。单位:字节。

8932

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetImageInfo
&ImageId=3e34733b40b9a96ccf5c1ff6f69****
&AuthTimeout=3600
&OutputType=cdn
&公共请求参数

正常返回示例

JSON格式

{
    "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": "测试",
        "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-shanghai.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D",
            "OriginalFileName": "****.gif",
            "Width": 200,
            "Height": 200,
            "FileSize": "8932"
        }
    }
}

XML格式

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

错误码

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

接口错误码

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

错误代码错误信息HTTP 状态码说明
NoSuchResourceThe specified resource does not exist.404图片不存在。
阿里云首页 视频点播 相关技术圈