Use GetAttachedMediaInfo to query information about auxiliary media assets - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the basic information and access URLs of multiple auxiliary media assets in a batch by specifying their IDs after the assets such as watermark images, subtitle files, and materials are uploaded to ApsaraVideo VOD.

Operation description

You can retrieve information about up to 20 auxiliary media assets at a time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetAttachedMediaInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	Yes	The auxiliary media asset IDs. Separate multiple IDs with commas (,). You can specify up to 20 IDs. The IDs are returned after you call the CreateUploadAttachedMedia operation to obtain the upload URL and credential for the auxiliary media asset.	eb1861d2c9a842340e989dd56**,0222e203cf80f9c22870a4d2c**
AuthTimeout	integer	No	The validity period of the auxiliary media asset URL. Unit: seconds. If OutputType is set to cdn: The URL expires only if URL authentication is enabled. Otherwise, the URL is permanently valid. Minimum value: 1. Maximum value: unlimited. Default value: If you do not specify this parameter, the default validity period specified in URL authentication is used. If OutputType is set to oss: The URL expires only if the storage permission is set to private. Otherwise, the URL is permanently valid. Minimum value: 1. Maximum value: To reduce security risks to the origin server, the maximum value is 2592000 (30 days) if the auxiliary media asset is stored in a bucket managed by ApsaraVideo VOD, and 129600 (36 hours) if the auxiliary media asset is stored in your own OSS bucket. Default value: If you do not specify this parameter, the value is 3600.	3600
OutputType	string	No	The type of the output URL. Valid values: oss: the back-to-origin URL. cdn (default): the CDN-accelerated URL.	oss

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	221BCB57-B217-42BF-619BD13378F9****
NonExistMediaIds	array	The IDs of the auxiliary media assets that do not exist.
	string	The IDs of the auxiliary media assets that do not exist.	eb1861d2c9a842340e989dd56****
AttachedMediaList	array<object>	The information about the auxiliary media assets.
	array<object>	The details of the auxiliary media asset.
Type	string	The type of the auxiliary media asset. Valid values: watermark: watermark. subtitle: subtitle. material: 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 is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-01-01T10:00:00Z
Status	string	The status of the auxiliary media asset. Valid values: Uploading: uploading. Normal: Normal. UploadFail: upload failed.	Normal
Tags	string	The tags. Note This parameter is returned only if the auxiliary media asset has tag information.	tag1,tag2
ModificationTime	string	The time when the auxiliary media asset was last updated. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2020-05-31T11:42:20Z
MediaId	string	The auxiliary media asset ID.	0222e203cf80f9c22870a4d2c****
Description	string	The description. Note This parameter is returned only if the auxiliary media asset has a description.	Description test
AppId	string	The application ID.	app-*****
URL	string	The access URL of the auxiliary media asset. Note If a CDN domain name is configured in ApsaraVideo VOD, the CDN URL is returned. Otherwise, the OSS URL is returned.	https://al***.cn/subtitle/9843C2*4E186F19B6.vtt?auth_key=159099f60e0b7fd59**
Title	string	The title.	Subtitle test
Categories	array<object>	The list of categories.
	object	The details of the category.
ParentId	integer	The ID of the parent category.	1000224336
CateName	string	The name of the category.	Test
CateId	integer	The ID of the category.	1000224338
Level	integer	The level of the category.	0

Examples

Success response

JSON format

{
  "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": "Test",
          "CateId": 1000224338,
          "Level": 0
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.