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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetAttachedMediaInfo

系统规定参数。取值:GetAttachedMediaInfo

MediaIds String eb1861d2c9a8*****42340e989dd56,0222e203cf80*****f9c22870a4d2c

辅助媒资ID。多个ID使用英文逗号(,)分隔,最多支持20个。

AuthTimeout Long 3600

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

说明
  • 如果OutputType取值为CDN
    • 只有开启了URL鉴权辅助媒资地址才会定期失效,否则会永久有效。
    • 最小值:1
    • 最大值:无限制。
    • 默认值:未设置时,取值为URL鉴权中设置的默认有效时长。
  • 如果OutputType取值为OSS
    • 只有存储权限为私有,播放地址才会定期失效,否则会永久有效。
    • 最小值:1
    • 最大值:为降低源站安全风险,最大值为2592000(即30天)。
    • 默认值:未设置时,取值为3600
OutputType String oss

输出地址类型。取值:

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

返回数据

名称 类型 示例值 描述
RequestId String 221BCB57-B217-42*****BF-619BD13378F9

请求ID。

NonExistMediaIds Array of String eb1861d2c9a8*****42340e989dd56

不存在的辅助媒资ID。

AttachedMediaList Array of AttachedMedia

辅助媒资信息列表。

Type String subtitle

辅助媒资类型。

  • watermark:水印。
  • subtitle:字幕。
  • material:素材。
StorageLocation String outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com

文件存储区域。

CreationTime String 2019-01-01T10:00:00Z

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

Status String Normal

辅助媒资状态。取值:

  • Uploading(上传中):初始状态,表示辅助媒资正在上传。
  • Normal(正常):辅助媒资上传成功。
  • UploadFail(失败):辅助媒资上传失败。
Tags String tag1,tag2

标签。

ModificationTime String 2020-05-31T11:42:20Z

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

MediaId String 0222e203cf80*****f9c22870a4d2c

辅助媒资ID。

Description String 描述测试

描述。

AppId String app-*****

应用ID。

URL String https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099*****f60e0b7fd59

辅助媒资URL。

说明 如果配置了CDN域名则为CDN地址,否则为OSS地址。
Title String 字幕测试

标题。

Categories Array of Category

分类列表。

ParentId Long -1

父分类ID,一级分类父ID为-1。

CateName String 测试

分类名称。

  • 最大64字节。
  • UTF8编码。
CateId Long 198673

视频分类ID。

Level Long 0

分类层级,一级分类层级为0。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=GetAttachedMediaInfo
&MediaIds=eb1861d2c9a8*****42340e989dd56,0222e203cf80*****f9c22870a4d2c
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetAttachedMediaInfoResponse>
<NonExistMediaIds>eb1861d2c9a8*****42340e989dd56</NonExistMediaIds>
<RequestId>221BCB57-B217-42*****BF-619BD13378F9</RequestId>
<AttachedMediaList>
    <Status>Normal</Status>
    <Type>subtitle</Type>
    <Description>描述测试</Description>
    <AppId>app-*****</AppId>
    <MediaId>0222e203cf80*****f9c22870a4d2c</MediaId>
    <CreationTime>2019-01-01T10:00:00Z</CreationTime>
    <Title>字幕测试</Title>
    <ModificationTime>2020-05-31T11:42:20Z</ModificationTime>
    <StorageLocation>outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>
    <URL>https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099*****f60e0b7fd59</URL>
    <Tags>tag1,tag2</Tags>
</AttachedMediaList>
<AttachedMediaList>
    <Categories>
        <ParentId>-1</ParentId>
        <Level>0</Level>
        <CateName>测试</CateName>
        <CateId>198673</CateId>
    </Categories>
</AttachedMediaList>
</GetAttachedMediaInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

ExceededMax

The input parameter “MediaIds” Exceed the limit.

400

辅助媒资ID超过上限20个。