文档

GetImageInfos - 批量获取图片信息

更新时间:

通过图片ID批量获取图片的基本信息及访问地址。

接口说明

  • 本接口仅支持查询上传到视频点播中的图片信息;如需查询通过视频截图生成的截图信息,请调用 ListSnapshots 接口查询。
  • 一次最多可查询 20 个图片的信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:GetImageInfosList
  • 全部资源
    *

请求参数

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

图片 ID 列表,多个 ID 之间使用半角逗号(,)分隔,最多支持 20 个 ID。可通过以下方式获取:

  • 可登录点播控制台,选择媒资库>图片,查看 ID。
  • 调用[CreateUploadImage(~~436544~~)获取上传地址和凭证时会返回。
  • 调用 SearchMedia 查询图片时会返回。
bbc65bba53fed90de118a7849****,594228cdd14b4d069fc17a8c4a****
AuthTimeoutlong

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

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

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

25818875-5F78-4AF6-D7393642CA58*****
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

图片类型。取值:

  • default:普通图片
  • cover:视频封面图
default
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
NonExistImageIdsarray

不存在的图片 ID 列表。

string

不存在的图片 ID 列表。

f45cf4eba5c80233389558c39****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58*****",
  "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": "测试",
      "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"
      }
    }
  ],
  "NonExistImageIds": [
    "f45cf4eba5c80233389558c39****"
  ]
}

错误码

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

  • 本页导读 (1)