Call GetVideoPlayAuth to obtain a playback credential for secure playback - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the playback credential (PlayAuth) for an audio or video file. ApsaraVideo Player SDK uses this credential to automatically obtain the playback URL. Because the playback credential has a validity period and is bound to a specific audio or video file, it cannot be shared or reused. An expired or invalid credential will cause playback failure. This playback method is suitable for audio and video playback scenarios that require high security.

Operation description

When using ApsaraVideo Player SDK (applicable to the PlayAuth playback method), call this operation to obtain the playback credential. ApsaraVideo Player SDK uses the playback credential to automatically obtain the playback URL for playback. For more information, see ApsaraVideo Player SDK.
If the playback credential expires, the playback URL cannot be obtained. You must obtain a new playback credential.

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:GetVideoPlayAuth

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	No	The audio or video ID. Only a single audio or video ID is supported. You can obtain the ID by using the following methods: For videos uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. When uploading audio or video files by calling the CreateUploadVideo operation, the audio or video ID is the value of the VideoId response parameter. After the audio or video file is uploaded, you can call the SearchMedia operation to query the audio or video ID, which is the value of the VideoId response parameter.	dfde02284a5c46622a097adaf44a****
AuthInfoTimeout	integer	No	The expiration time of the playback credential. Unit: seconds. If the credential expires, the playback URL cannot be obtained. You must obtain a new credential. Default value: 100. Valid values: `[100,3000]`.	100
ApiVersion	string	No	The API version number. Set the value to 1.0.0.	1.0.0
ReferenceId	string	No	The custom ID. Only lowercase letters, uppercase letters, digits, hyphens, and underscores are supported. Length: 6 to 64 characters. The ID is unique per user.	123-123

Response elements

Element	Type	Description	Example
	object	The response parameters.
PlayAuth	string	The playback credential for the audio or video file.	sstyYuew6789000000xtt7TYUh****
RequestId	string	The request ID.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMeta	object	The metadata of the audio or video file.
Status	string	The status of the audio or video file. For valid values and descriptions, see Status: audio and video status.	Normal
Duration	number	The duration of the audio or video file. Unit: seconds.	120.0
Title	string	The title of the audio or video file.	Alibaba Cloud VOD Video Title
VideoId	string	The audio or video ID.	dfde02284a5c46622a097adaf44a****
CoverURL	string	The thumbnail URL of the audio or video file.	https://example.aliyundoc.com/****.jpg

Examples

Success response

JSON format

{
  "PlayAuth": "sstyYuew6789000000xtt7TYUh****",
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "VideoMeta": {
    "Status": "Normal",
    "Duration": 120,
    "Title": "Alibaba Cloud VOD Video Title",
    "VideoId": "dfde02284a5c46622a097adaf44a****",
    "CoverURL": "https://example.aliyundoc.com/****.jpg"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.