调用GetImageInfo通过图片ID获取图片的基本信息及访问地址。
使用说明
调用本接口通过图片ID来获取图片的基本信息,包括图片标题、类型、创建时间、标签、图片的访问地址等。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetImageInfo |
系统规定参数。取值:GetImageInfo。 |
ImageId | String | 是 | 3e34733b40b9a96ccf5c1ff6f69**** |
图片ID。可通过以下方式获取:
|
AuthTimeout | Long | 否 | 3600 |
图片访问地址的过期时间。单位:秒。
|
OutputType | String | 否 | cdn |
输出的图片访问地址的类型。取值范围 :
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | AB99D4DF-FAFA-49DC-9C548C1E261E**** |
请求ID。 |
ImageInfo | Object |
图片信息。 |
|
CreationTime | String | 2018-11-21T02:37:23Z |
图片创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
StorageLocation | String | outin-****..oss-cn-shanghai.aliyuncs.com |
图片文件的存储地址。 |
Status | String | Uploading |
图片状态。取值:
|
CateId | Long | 254766071 |
分类ID。 |
Tags | String | tag1,tag2,tag3 |
图片标签。多个标签之间使用半角逗号(,)分隔。 |
ImageType | String | NormalSnapshot |
图片类型。取值:
|
CateName | String | 测试 |
分类名称。 |
Description | String | 测试描述 |
图片描述。 |
AppId | String | app-**** |
应用ID。 |
URL | String | http://example.aliyundoc.com/image/default/****.gif?auth_key=**** |
图片访问地址(如果配置了CDN域名则为CDN地址,否则为OSS地址)。 |
Title | String | this is a sample |
图片标题。 |
ImageId | String | bbc65bba53f9*****ed90de118a7849 |
图片ID。 |
Mezzanine | Object |
图片源信息。 |
|
FileURL | String | https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D |
图片文件的OSS地址。 |
OriginalFileName | String | ****.gif |
上传的源文件名称。 |
Width | Integer | 200 |
图片宽度。单位:像素。 |
Height | Integer | 200 |
图片高度。单位:像素。 |
FileSize | String | 8932 |
文件大小。单位:字节。 |
示例
请求示例
http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetImageInfo
&ImageId=3e34733b40b9a96ccf5c1ff6f69****
&AuthTimeout=3600
&OutputType=cdn
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/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&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D</FileURL>
<OriginalFileName>****.gif</OriginalFileName>
<Width>200</Width>
<Height>200</Height>
<FileSize>8932</FileSize>
</Mezzanine>
</ImageInfo>
</GetImageInfoResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
}
}
}
错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
错误代码 |
错误信息 |
HTTP 状态码 |
说明 |
---|---|---|---|
NoSuchResource |
The specified resource does not exist. |
404 |
图片不存在。 |
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: