GetVideoPlayAuth - ApsaraVideo VOD

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: 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 media file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console. Obtain the value of the VideoId parameter from the response to the CreateUploadVideo operation. Obtain the value of the VideoId parameter from the response to the SearchMedia operation. This method is applicable to files that have been uploaded.	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. Default value: 100. Valid values: `[100,3000]`.	100
ApiVersion	string	No	The API version. Set the value to 1.0.0.	1.0.0

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PlayAuth	string	The credential for media playback.	sstyYuew6789000000xtt7TYUh****
RequestId	string	The ID of the request.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMeta	object	The metadata of the audio or video file.
Status	string	The status of the media file. For more information about the value range and description, see Status: the status of a video.	Normal
Duration	float	The duration of the media file. Unit: seconds.	120.0
Title	string	The title of the media file.	VOD
VideoId	string	The ID of the media file.	dfde02284a5c46622a097adaf44a****
CoverURL	string	The thumbnail URL of the media file.	https://example.aliyundoc.com/****.jpg

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.