Queries the credential required for media playback. ApsaraVideo Player SDK automatically obtains the playback URL based on the playback credential. Each playback credential can be used to obtain the playback URL only for a specific video in a specific period of time. You cannot obtain the playback URL if the credential expires or is incorrect. You can use PlayAuth-based playback when you require high security for audio and video playback.
Operation description
- You can call this operation to obtain a playback credential when you use ApsaraVideo Player SDK to play a media file based on PlayAuth. The credential is used to obtain the playback URL. For more information, see ApsaraVideo Player SDK.
- You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:GetVideoPlayAuth | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| VideoId | string | Yes | The ID of the media file. You can specify only one ID. You can use one of the following methods to obtain the ID of the file:
| dfde02284a5c46622a097adaf44a**** |
| AuthInfoTimeout | long | No | The validity period of the playback credential. Unit: seconds. You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.
| 100 |
| ApiVersion | string | No | The API version. Set the value to 1.0.0. | 1.0.0 |
Response parameters
Examples
Sample success responses
JSONformat
{
"PlayAuth": "sstyYuew6789000000xtt7TYUh****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"VideoMeta": {
"Status": "Normal",
"Duration": 120,
"Title": "VOD",
"VideoId": "dfde02284a5c46622a097adaf44a****",
"CoverURL": "https://example.aliyundoc.com/****.jpg"
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2021-11-02 | The request parameters of the API has changed | View Change Details |
Common errors
The following table describes the common errors that this operation can return.
| Error code | Error message | HTTP status code | Description |
|---|---|---|---|
| Forbidden.IllegalStatus | Status of the video is illegal. | 403 | The error message returned because the video status is invalid. |
| InvalidVideo.NotFound | The video does not exist. | 404 | The error message returned because the video does not exist. |
| MissingVideoId | VideoId is mandatory for this action. | 400 | The error message returned because the VideoId parameter is not specified. |