GetVideoPlayAuth - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Call this operation to obtain the playback credential (PlayAuth) for an audio or video file. The ApsaraVideo Player SDK uses this credential to automatically retrieve the playback URL. A playback credential is valid for a limited time and is bound to a specific audio or video file. Do not use the same credential for different files. If a credential expires or is invalid, playback fails. This method is suitable for playback scenarios that require high security.

Operation description

If you use PlayAuth for playback, you must use the ApsaraVideo Player SDK. Call this operation to obtain a playback credential, which the SDK uses to automatically retrieve the playback URL. For more information, see ApsaraVideo Player SDK.
If a playback credential expires, you cannot retrieve the playback URL. You must obtain a new 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 ID of the audio or video file. You can specify only one ID. You can obtain the ID in one of the following ways: Log on to the VOD console. In the navigation pane, choose Media Assets > Audio/Video to view the file ID. Call the CreateUploadVideo operation to upload a file. The value of the VideoId parameter in the response is the file ID. After a file is uploaded, call the SearchMedia operation to query the file ID. The value of the VideoId parameter in the response is the file ID.	dfde02284a5c46622a097adaf44a****
AuthInfoTimeout	integer	No	The time-to-live (TTL) of the playback credential, in seconds. If the credential expires, you cannot get the playback URL. Get a new credential. Default value: 100. Valid values: `[100,3000]`.	100
ApiVersion	string	No	The API version. Set the value to 1.0.0.	1.0.0
ReferenceId	string	No	A custom ID that is 6 to 64 characters in length. It can contain lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be unique for each user.	123-123

Response elements

Element	Type	Description	Example
	object	The returned result.
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 more information about the valid values and descriptions, see Status of an audio or video file.	Normal
Duration	number	The duration of the audio or video file, in seconds.	120.0
Title	string	The title of the audio or video file.	Alibaba Cloud VOD Video Title
VideoId	string	The ID of the audio or video file.	dfde02284a5c46622a097adaf44a****
CoverURL	string	The URL of the thumbnail 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.