GetAttachedMediaInfo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the URL and basic information about one or more auxiliary media assets such as watermark images, subtitle files, and materials based on IDs.

Operation description

You can query information about up to 20 auxiliary media assets in a request.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vod:GetAttachedMediaInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	Yes	The ID of the auxiliary media asset. Separate multiple IDs with commas (,). You can specify up to 20 IDs. You can obtain the ID from the response to the CreateUploadAttachedMedia operation that you call to obtain the upload URL and credential.	eb1861d2c9a842340e989dd56**,0222e203cf80f9c22870a4d2c**
AuthTimeout	long	No	The validity period of the URL. Unit: seconds. If you set the OutputType parameter to cdn: The URL of the auxiliary media asset has a validity period only if URL signing is enabled. Otherwise, the URL of the auxiliary media asset is permanently valid. Minimum value: 1. Maximum value: unlimited. Default value: If you do not set this parameter, the default validity period that is specified in URL signing is used. If you set the OutputType parameter to oss: The URL of the auxiliary media asset has a validity period only if the permissions on the Object Storage Service (OSS) bucket are private. Otherwise, the URL of the auxiliary media asset is permanently valid. Minimum value: 1. The maximum value for a media asset stored in the VOD bucket is 2592000 (30 days) and the maximum value for a media asset stored in an OSS bucket is 129600 (36 hours). The maximum value is limited to reduce security risks of the origin. Default value: If you do not set this parameter, the default value 3600 is used.	3600
OutputType	string	No	The type of the media asset URL. Valid values: oss cdn (default)	oss

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	221BCB57-B217-42BF-619BD13378F9****
NonExistMediaIds	array	The IDs of the auxiliary media assets that do not exist.
MediaId	string	The ID of the auxiliary media assets that does not exist.	eb1861d2c9a842340e989dd56****
AttachedMediaList	array<object>	The information about the media assets.
AttachedMedia	object	The details of the auxiliary media asset.
Type	string	The type of the auxiliary media asset. watermark subtitle material	subtitle
StorageLocation	string	The storage address of the auxiliary media asset.	outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com
CreationTime	string	The time when the auxiliary media asset was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-01-01T10:00:00Z
Status	string	The status of the auxiliary media asset. Valid values: Uploading Normal UploadFail	Normal
Tags	string	The tags of the auxiliary media asset. Note This parameter is returned only when tags are specified for the auxiliary media asset.	tag1,tag2
ModificationTime	string	The time when the auxiliary media asset was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-05-31T11:42:20Z
MediaId	string	The ID of the auxiliary media asset.	0222e203cf80f9c22870a4d2c****
Description	string	The description of the auxiliary media asset. Note This parameter is returned only when a description is specified for the auxiliary media asset.	description test
AppId	string	The ID of the application.	app-*****
URL	string	The URL of the auxiliary media asset. Note If a CDN domain name is specified, a CDN URL is returned. Otherwise, an OSS URL is returned.	https://al***.cn/subtitle/9843C2*4E186F19B6.vtt?auth_key=159099f60e0b7fd59**
Title	string	The title of the auxiliary media asset.	subtitle test
Categories	array<object>	The categories.
Category	object	The details about the category.
ParentId	long	The ID of the parent category.	1000224336
CateName	string	The name of the category.	category test
CateId	long	The ID of the category.	1000224338
Level	long	The level of the category.	0

Examples

Sample success responses

JSONformat

{
  "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": "description test",
      "AppId": "app-*****",
      "URL": "https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099f60e0b7fd59****",
      "Title": "subtitle test",
      "Categories": [
        {
          "ParentId": 1000224336,
          "CateName": "category test",
          "CateId": 1000224338,
          "Level": 0
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

The ID of the auxiliary media asset.