GetVodPackagingAsset

Updated at:

Queries a VOD packaging asset.

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

ice:GetVodPackagingAsset

get

*All Resource

*

None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AssetName

string

No

The name of the VOD packaging asset.

30min_movie

Response elements

Element

Type

Description

Example

object

The result of asset query.

RequestId

string

The ID of the request.

0622C702-41BE-467E-AF2E-883D4517962E

Asset

object

The information about the asset.

AssetName

string

The name of the asset.

30min_movie

GroupName

string

The name of the packaging group.

vod_hls

Input

object

The asset input configurations.

Type

string

The input type. Only Object Storage Service (OSS) is supported.

OSS

Media

string

The URL of the media file. Only M3U8 files stored in OSS are supported.

OSS://***test-bucket***/***video/input.m3u8

CreateTime

string

The time when the asset was created. It follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2024-11-21T06:45:32Z

EgressEndpoints

array<object>

The egress endpoints, each corresponding to a packaging configuration.

object

The egress endpoint.

Url

string

The playback URL. If the asset fails to be packaged, no playback URL is returned.

https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8

Status

string

The asset status. Valid values:

  • Queuing: The asset is waiting for packaging.

  • Playable: The asset is packaged and playable.

  • Failed: The asset fails to be packaged.

Playable

ConfigurationName

string

The name of the packaging configuration.

hls_3s

ContentId

string

The content ID in the DRM system. The maximum length is 256 characters. Letters, digits, underscores (_), and hyphens (-) are supported.

movie

Examples

Success response

JSON format

{
  "RequestId": "0622C702-41BE-467E-AF2E-883D4517962E",
  "Asset": {
    "AssetName": "30min_movie",
    "GroupName": "vod_hls",
    "Input": {
      "Type": "OSS",
      "Media": "OSS://***test-bucket***/***video/input.m3u8"
    },
    "CreateTime": "2024-11-21T06:45:32Z",
    "EgressEndpoints": [
      {
        "Url": "https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8",
        "Status": "Playable",
        "ConfigurationName": "hls_3s"
      }
    ],
    "ContentId": "movie"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.