GetAttachedMediaInfo - 批量获取辅助媒资信息

当水印图片、字幕文件、素材等辅助媒资上传到视频点播后,可以调用GetAttachedMediaInfo传入多个辅助媒资ID批量获取辅助媒资的基本信息及访问地址。

接口说明

一次最多支持获取 20 个辅助媒资的信息。

调试

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

授权信息

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

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

请求参数

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

辅助媒资 ID。

  • 多个 ID 之间使用半角逗号(,)分隔,最多支持 20 个 ID。
  • 调用 CreateUploadAttachedMedia 接口获取辅助媒资上传地址和凭证后,会返回。
eb1861d2c9a842340e989dd56****,0222e203cf80f9c22870a4d2c****
AuthTimeoutlong

辅助媒资地址过期时间,单位:秒。

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

输出地址类型。取值:

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

221BCB57-B217-42BF-619BD13378F9****
NonExistMediaIdsarray

不存在的辅助媒资 ID。

string

不存在的辅助媒资 ID。

eb1861d2c9a842340e989dd56****
AttachedMediaListarray<object>

辅助媒资信息列表。

object

辅助媒资详情。

Typestring

辅助媒资类型。

  • watermark:水印。
  • subtitle:字幕。
  • material:素材。
subtitle
StorageLocationstring

辅助媒资的存储地址。

outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com
CreationTimestring

辅助媒资创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-01-01T10:00:00Z
Statusstring

辅助媒资状态。取值:

  • Uploading:上传中。
  • Normal:正常。
  • UploadFail:上传失败。
Normal
Tagsstring

标签。

说明 仅当辅助媒资有标签信息时,才会返回此参数。
tag1,tag2
ModificationTimestring

辅助媒资的最后更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2020-05-31T11:42:20Z
MediaIdstring

辅助媒资 ID。

0222e203cf80f9c22870a4d2c****
Descriptionstring

描述。

说明 仅当辅助媒资有描述信息时,才会返回此参数。
描述测试
AppIdstring

应用 ID。

app-*****
URLstring

辅助媒资的访问地址。

说明 如果点播配置了 CDN 域名则为 CDN 地址,否则为 OSS 地址。
https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099f60e0b7fd59****
Titlestring

标题。

字幕测试
Categoriesarray<object>

分类列表。

object

分类详情。

ParentIdlong

父分类 ID。

1000224336
CateNamestring

分类名称。

测试
CateIdlong

分类 ID。

1000224338
Levellong

分类层级。

0

示例

正常返回示例

JSON格式

{
  "RequestId": "221BCB57-B217-42BF-619BD13378F9****",
  "NonExistMediaIds": [
    "eb1861d2c9a842340e989dd56****"
  ],
  "AttachedMediaList": [
    {
      "Type": "subtitle",
      "StorageLocation": "outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com",
      "CreationTime": "2019-01-01T10:00:00Z",
      "Status": "Normal",
      "Tags": "tag1,tag2",
      "ModificationTime": "2020-05-31T11:42:20Z",
      "MediaId": "0222e203cf80f9c22870a4d2c****",
      "Description": "描述测试",
      "AppId": "app-*****",
      "URL": "https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099f60e0b7fd59****",
      "Title": "字幕测试",
      "Categories": [
        {
          "ParentId": 1000224336,
          "CateName": "测试",
          "CateId": 1000224338,
          "Level": 0
        }
      ]
    }
  ]
}

错误码

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

接口错误码

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

错误代码错误信息HTTP 状态码说明
ExceededMaxThe input parameter “MediaIds” Exceed the limit.400辅助媒资 ID 超过上限 20 个。