首页 视频点播 API参考指南 API目录 媒资管理 辅助媒资管理 GetAttachedMediaInfo - 获取辅助媒资信息

GetAttachedMediaInfo - 获取辅助媒资信息

获取辅助媒资的基本信息,包括标题、类型、标签、创建时间等。

接口说明

使用说明

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

QPS限制

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

调试

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

调试

授权信息

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

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

请求参数

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

辅助媒资ID。为获取辅助媒资上传地址和凭证接口返回参数MediaId的值。多个ID之间使用半角逗号(,)分隔,最多支持20个。

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

辅助媒资详情。

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

辅助媒资URL。

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

标题。

字幕测试
Categoriesarray

分类列表。

object

分类详情。

ParentIdlong

父分类ID。

1000224336
CateNamestring

分类名称。

  • 最大64字节。
  • UTF8编码。
测试
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个。
阿里云首页 视频点播 相关技术圈