All Products
Search
Document Center

ApsaraVideo VOD:GetVideoPlayAuth

Last Updated:Dec 14, 2022

Queries the credential required for media 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.
  • You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:GetVideoPlayAuthRead
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdstringYes

The ID of the audio or video file. You can use one of the following methods to obtain the ID of the file:

  • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
  • Obtain the value of the VideoId parameter when you call the CreateUploadVideo operation to upload files.
  • Obtain the value of the VideoId parameter by calling the SearchMedia operation. This method is applicable to files that have been uploaded.
dfde02284a5c46622a097adaf44a****
AuthInfoTimeoutlongNo

The time when the playback credential expires. Unit: seconds. You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.

  • Default value: 100.
  • Valid values: 100 to 3000.
100
ApiVersionstringNo

The API version number. Set the value to 1.0.0.

1.0.0

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

PlayAuthstring

The credential for video or audio playback.

sstyYuew6789000000xtt7TYUh****
RequestIdstring

The ID of the request.

E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMetaobject

The metadata of the audio or video file.

Statusstring

The status of the audio or video file. For more information about the value range and description, see the Status table.

Normal
Durationnumber

The duration of the audio or video file. Unit: seconds.

120.0
Titlestring

The title of the audio or video file.

VOD
VideoIdstring

The ID of the audio or video file.

dfde02284a5c46622a097adaf44a****
CoverURLstring

The thumbnail URL of the audio or video file.

https://example.aliyundoc.com/****.jpg

Example

Normal return example

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 API error center.

Change history

Change timeSummary of changesOperate
2021-11-02The input parameters of the API operation has changed
Change itemChange content
Input ParametersThe input parameters of the API operation has changed
    Added Input Parameters: ApiVersion

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
Forbidden.IllegalStatusStatus of the video is illegal.403The error message returned because the video status is invalid.
InvalidVideo.NotFoundThe video does not exist.404The error message returned because the video does not exist.
MissingVideoIdVideoId is mandatory for this action.400The error message returned because the VideoId parameter is not specified.