All Products
Search
Document Center

ApsaraVideo VOD:GetAttachedMediaInfo

Last Updated:May 22, 2024

Queries the basic information about one or more auxiliary media assets. The basic information includes the title, type, tags, and creation time of an auxiliary media asset.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GetAttachedMediaInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MediaIdsstringYes

The ID of the auxiliary media asset. Separate multiple IDs with commas (,). A maximum of 20 IDs can be specified.

eb1861d2c9a842340e989dd56****,0222e203cf80f9c22870a4d2c****
AuthTimeoutlongNo

The validity period of the URL of the auxiliary media asset. Unit: seconds.

Note
  • If the OutputType parameter is set 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 the OutputType parameter is set 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.
    • Maximum value: 2592000 (30 days). The maximum value is limited to reduce security risks of the origin.
    • Default value: If you do not set this parameter, the default value is 3600.
  • 3600
    OutputTypestringNo

    The type of the URL of the auxiliary media asset. Valid values:

    • oss: OSS URL
    • cdn (default): Content Delivery Network (CDN) URL
    oss

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    RequestIdstring

    The ID of the request.

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

    The IDs of the auxiliary media assets that do not exist.

    string

    The IDs of the auxiliary media assets that do not exist.

    eb1861d2c9a842340e989dd56****
    AttachedMediaListobject []

    The information about the media asset.

    Typestring

    The type of the auxiliary media asset. Valid values:

    • watermark
    • subtitle
    • material
    subtitle
    StorageLocationstring

    The OSS bucket where the auxiliary media asset is stored.

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

    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
    Statusstring

    The status of the auxiliary media asset. Valid values:

    • Uploading: The auxiliary media asset is being uploaded. This is the initial status.
    • Normal: The auxiliary media asset is uploaded.
    • UploadFail: The auxiliary media asset fails to be uploaded.
    Normal
    Tagsstring

    The tags of the auxiliary media asset.

    tag1,tag2
    ModificationTimestring

    The time when the auxiliary media asset was 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
    MediaIdstring

    The ID of the auxiliary media asset.

    0222e203cf80f9c22870a4d2c****
    Descriptionstring

    The description of the auxiliary media asset.

    description test
    AppIdstring

    The ID of the application.

    app-*****
    URLstring

    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****
    Titlestring

    The title of the auxiliary media asset.

    subtitle test
    Categoriesobject []

    The list of categories.

    ParentIdlong

    The ID of the parent category. The parent category ID of a level 1 category is -1.

    1000224336
    CateNamestring

    The name of the category.

    • The value can be up to 64 bytes in length.
    • The string must be encoded in the UTF-8 format.
    category test
    CateIdlong

    The ID of the video category.

    1000224338
    Levellong

    The level of the category. A value of 0 indicates a level 1 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.